Share via

ObservabilityConfiguration class

Package:
@microsoft/agents-a365-observability

Configuration for observability package. Inherits runtime settings and adds observability-specific settings.

Extends
RuntimeConfiguration

Constructors

ObservabilityConfiguration(ObservabilityConfigurationOptions)

Properties

clusterCategory
isDevelopmentEnvironment

Whether the cluster is a development environment (local or dev). Based on clusterCategory.
isNodeEnvDevelopment

Whether NODE_ENV indicates development mode. Returns true when NODE_ENV is 'development' (case-insensitive). This is the standard Node.js way of indicating development mode.
isObservabilityExporterEnabled
observabilityAuthenticationScopes

Gets the observability authentication scopes. Used by AgenticTokenCache for observability service authentication.
observabilityDomainOverride
observabilityLogLevel

Inherited Methods

parseEnvBoolean(undefined | string)

Parse an environment variable as a boolean. Recognizes 'true', '1', 'yes', 'on' (case-insensitive) as true; all other values as false.
parseEnvInt(undefined | string, number)

Parse an environment variable as an integer, returning fallback if invalid or not set.

Constructor Details

ObservabilityConfiguration(ObservabilityConfigurationOptions) 

new ObservabilityConfiguration(overrides?: ObservabilityConfigurationOptions)

Parameters

overrides
ObservabilityConfigurationOptions

Property Details

clusterCategory 

ClusterCategory clusterCategory

Property Value

ClusterCategory

isDevelopmentEnvironment

Whether the cluster is a development environment (local or dev). Based on clusterCategory.

boolean isDevelopmentEnvironment

Property Value

boolean

isNodeEnvDevelopment

Whether NODE_ENV indicates development mode. Returns true when NODE_ENV is 'development' (case-insensitive). This is the standard Node.js way of indicating development mode.

boolean isNodeEnvDevelopment

Property Value

boolean

isObservabilityExporterEnabled 

boolean isObservabilityExporterEnabled

Property Value

boolean

observabilityAuthenticationScopes

Gets the observability authentication scopes. Used by AgenticTokenCache for observability service authentication.

readonly string[] observabilityAuthenticationScopes

Property Value

readonly string[]

observabilityDomainOverride 

null | string observabilityDomainOverride

Property Value

null | string

observabilityLogLevel 

string observabilityLogLevel

Property Value

string

Inherited Method Details

parseEnvBoolean(undefined | string)

Parse an environment variable as a boolean. Recognizes 'true', '1', 'yes', 'on' (case-insensitive) as true; all other values as false.

static function parseEnvBoolean(envValue: undefined | string): boolean

Parameters

envValue

undefined | string

Returns

boolean

Inherited From RuntimeConfiguration.parseEnvBoolean

parseEnvInt(undefined | string, number)

Parse an environment variable as an integer, returning fallback if invalid or not set.

static function parseEnvInt(envValue: undefined | string, fallback: number): number

Parameters

envValue

undefined | string

fallback

number

Returns

number

Inherited From RuntimeConfiguration.parseEnvInt