Interface TracingOptions

The options to configure the tracing functionality.

interface TracingOptions {
    attributes?: Attributes;
    autoInstrumentationsConfigMap?: InstrumentationConfigMap;
    debug?: boolean;
    hostname?: string;
    instrumentations?: InstrumentationOption[];
    isEnabled?: boolean;
    serviceName?: string;
    serviceVersion?: string;
    traceRatio?: number;
    url?: string;
}

Hierarchy

  • Partial<TracingConfig>
    • TracingOptions

Properties

attributes? autoInstrumentationsConfigMap? debug? hostname? instrumentations? isEnabled? serviceName? serviceVersion? traceRatio? url?

Properties

Optionalattributes

attributes?: Attributes

Optional attributes to be added to the resource.

OptionalautoInstrumentationsConfigMap

autoInstrumentationsConfigMap?: InstrumentationConfigMap

Optional map of auto-instrumentation configurations.

Optionaldebug

debug?: boolean

Optional flag to enable debug mode.

Optionalhostname

hostname?: string

The value of the hostname attribute to use, will override the hostname.

Optionalinstrumentations

instrumentations?: InstrumentationOption[]

Optional array of instrumentations.

OptionalisEnabled

isEnabled?: boolean

Specifies whether tracing is enabled.

OptionalserviceName

serviceName?: string

The name of the service to put as attribute. By default will be read from the package.json file.

OptionalserviceVersion

serviceVersion?: string

The version of the service to put as attribute. By default will be read from the package.json file.

OptionaltraceRatio

traceRatio?: number

The ratio of traces to sample.

Optionalurl

url?: string

The URL to an HTTP OTLP endpoint to send the traces to.

Settings

Member Visibility

On This Page

Properties