io.opencensus.contrib.agent

Class Settings

java.lang.Object

io.opencensus.contrib.agent.Settings

public class Settings
extends Object

The Settings class provides access to user-configurable settings.

Since:

0.10

Constructor Summary

Constructors

Constructor and Description
Settings(com.typesafe.config.Config config) Creates agent settings.

Method Summary

Modifier and Type	Method and Description
boolean	isEnabled(String featurePath) Checks whether a feature is enabled in the effective configuration.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Settings

@Internal
public Settings(com.typesafe.config.Config config)

Creates agent settings.

Method Detail

isEnabled

public boolean isEnabled(String featurePath)

Checks whether a feature is enabled in the effective configuration.

A feature is identified by a path expression relative to CONFIG_ROOT, such as context-propagation.executor. The feature is enabled iff the config element at the requested path has a child element enabled with a value of true, on, or yes.

Parameters:

featurePath - the feature's path expression

Returns:

true, if enabled, otherwise false

Since:

0.10