AzureMonitorExporterOptions interface

Package:
@azure/monitor-opentelemetry-exporter

Provides configuration options for AzureMonitorTraceExporter.

Extends
ApplicationInsightsClientOptionalParams

Properties

apiVersion

Azure service API version.
connectionString

Azure Monitor Connection String, if not provided the exporter will try to use environment variable APPLICATIONINSIGHTS_CONNECTION_STRING Ex: "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://dc.services.visualstudio.com"
credential

Token Credential
disableOfflineStorage

Disable offline storage when telemetry cannot be exported.
storageDirectory

Directory to store retriable telemetry when it fails to export.

Inherited Properties

additionalPolicies

Additional policies to include in the HTTP pipeline.
agent

Options for configuring Agent instance for outgoing requests
allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS
baseUri

If specified, this is the base URI that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property.
baseUrl

Base url for the client
credentials

Credentials information
credentialScopes

If specified, will be used to build the BearerTokenAuthenticationPolicy.
endpoint

Overrides client endpoint.
host

Breeze endpoint: https://dc.services.visualstudio.com
httpClient

The HttpClient that will be used to send HTTP requests.
loggingOptions

Options to configure request/response logging.
pipeline

A customized pipeline to use, otherwise a default one will be created.
proxyOptions

Options to configure a proxy for outgoing requests.
redirectOptions

Options for how redirect responses are handled.
requestContentType

The default request content type for the service. Used if no requestContentType is present on an OperationSpec.
retryOptions

Options that control how to retry failed requests.
telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.
tlsOptions

Options for configuring TLS authentication
userAgentOptions

Options for adding user agent details to outgoing requests.

Property Details

apiVersion

Azure service API version.

apiVersion?: V2

Property Value

V2

connectionString

Azure Monitor Connection String, if not provided the exporter will try to use environment variable APPLICATIONINSIGHTS_CONNECTION_STRING Ex: "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://dc.services.visualstudio.com"

connectionString?: string

Property Value

string

credential

Token Credential

credential?: TokenCredential

Property Value

TokenCredential

disableOfflineStorage

Disable offline storage when telemetry cannot be exported.

disableOfflineStorage?: boolean

Property Value

boolean

storageDirectory

Directory to store retriable telemetry when it fails to export.

storageDirectory?: string

Property Value

string

Inherited Property Details

additionalPolicies

Additional policies to include in the HTTP pipeline.

additionalPolicies?: AdditionalPolicyConfig[]

Property Value

AdditionalPolicyConfig[]

Inherited From ApplicationInsightsClientOptionalParams.additionalPolicies

agent

Options for configuring Agent instance for outgoing requests

agent?: Agent

Property Value

Agent

Inherited From ApplicationInsightsClientOptionalParams.agent

allowInsecureConnection

Set to true if the request is sent over HTTP instead of HTTPS

allowInsecureConnection?: boolean

Property Value

boolean

Inherited From ApplicationInsightsClientOptionalParams.allowInsecureConnection

baseUri

Warning

This API is now deprecated.

This property is deprecated and will be removed soon, please use endpoint instead

If specified, this is the base URI that requests will be made against for this ServiceClient. If it is not specified, then all OperationSpecs must contain a baseUrl property.

baseUri?: string

Property Value

string

Inherited From ApplicationInsightsClientOptionalParams.baseUri

baseUrl

Warning

This API is now deprecated.

This property is deprecated and will be removed soon, please use endpoint instead

Base url for the client

baseUrl?: string

Property Value

string

Inherited From ApplicationInsightsClientOptionalParams.baseUrl

credentials

Credentials information

credentials?: { apiKeyHeaderName?: string, scopes?: string[] }

Property Value

{ apiKeyHeaderName?: string, scopes?: string[] }

Inherited From ApplicationInsightsClientOptionalParams.credentials

credentialScopes

If specified, will be used to build the BearerTokenAuthenticationPolicy.

credentialScopes?: string | string[]

Property Value

string | string[]

Inherited From ApplicationInsightsClientOptionalParams.credentialScopes

endpoint

Overrides client endpoint.

endpoint?: string

Property Value

string

Inherited From ApplicationInsightsClientOptionalParams.endpoint

host

Breeze endpoint: https://dc.services.visualstudio.com

host?: string

Property Value

string

Inherited From ApplicationInsightsClientOptionalParams.host

httpClient

The HttpClient that will be used to send HTTP requests.

httpClient?: HttpClient

Property Value

HttpClient

Inherited From ApplicationInsightsClientOptionalParams.httpClient

loggingOptions

Options to configure request/response logging.

loggingOptions?: LogPolicyOptions

Property Value

LogPolicyOptions

Inherited From ApplicationInsightsClientOptionalParams.loggingOptions

pipeline

A customized pipeline to use, otherwise a default one will be created.

pipeline?: Pipeline

Property Value

Pipeline

Inherited From ApplicationInsightsClientOptionalParams.pipeline

proxyOptions

Options to configure a proxy for outgoing requests.

proxyOptions?: ProxySettings

Property Value

ProxySettings

Inherited From ApplicationInsightsClientOptionalParams.proxyOptions

redirectOptions

Options for how redirect responses are handled.

redirectOptions?: RedirectPolicyOptions

Property Value

RedirectPolicyOptions

Inherited From ApplicationInsightsClientOptionalParams.redirectOptions

requestContentType

The default request content type for the service. Used if no requestContentType is present on an OperationSpec.

requestContentType?: string

Property Value

string

Inherited From ApplicationInsightsClientOptionalParams.requestContentType

retryOptions

Options that control how to retry failed requests.

retryOptions?: PipelineRetryOptions

Property Value

PipelineRetryOptions

Inherited From ApplicationInsightsClientOptionalParams.retryOptions

telemetryOptions

Options for setting common telemetry and tracing info to outgoing requests.

telemetryOptions?: TelemetryOptions

Property Value

TelemetryOptions

Inherited From ApplicationInsightsClientOptionalParams.telemetryOptions

tlsOptions

Options for configuring TLS authentication

tlsOptions?: TlsSettings

Property Value

TlsSettings

Inherited From ApplicationInsightsClientOptionalParams.tlsOptions

userAgentOptions

Options for adding user agent details to outgoing requests.

userAgentOptions?: UserAgentPolicyOptions

Property Value

UserAgentPolicyOptions

Inherited From ApplicationInsightsClientOptionalParams.userAgentOptions