@interopio/desktop API Reference

Properties (43)

Property Type Default Required Description
additionalAttributes⚓︎ { [x: string]: unknown } | (() => { [x: string]: unknown }) x x

Additional span attributes to publish as part of each span, specified as key/value pairs. You can use environment variables as values. Environment variables must start and end with a percent sign (e.g., %MyEnvVar%), and can contain a fallback value (e.g., %MyEnvVar?literalDefaultValue%).
additionalResourceAttributes⚓︎ { [x: string]: unknown } | (() => { [x: string]: unknown }) x x

Additional attributes to publish as part of the OTEL resource definition, specified as key/value pairs. You can use environment variables as values. Environment variables must start and end with a percent sign (e.g., %MyEnvVar%), and can contain a fallback value (e.g., %MyEnvVar?literalDefaultValue%).
addResourceAttributesToAttributes⚓︎ boolean false x

Whether to add resource attributes to span attributes.
clickstream⚓︎ boolean | "nested" | "sibling" | ClickstreamTraceConfig true x

Whether the clickstream trace will be enabled. false - clickstream trace is disabled. true - same as sibling nested - clickstream trace is enabled and each subsequent span is a child span of the previous one. sibling - clickstream trace is enabled and each subsequent span is a child of the same initial span.
closeTrace⚓︎ boolean false x

If true, the application will create a span with the name interopio.api.application.close when it's being closed. This functionality requires close handlers to be enabled in the application configuration.
compression⚓︎ CompressionAlgorithm x x

Compression algorithm to use when exporting trace.
concurrencyLimit⚓︎ number x x

Maximum number of concurrent trace export requests.
console⚓︎ boolean x x

If an OTEL TraceProvider isn't provided to the library, it will initialize its own.

If 'console' is 'true', TracerProvider will have a ConsoleTraceExporter.
contextManager⚓︎ (tracesSettings: TracesSettings, settings: Settings) => ContextManager x x

Allows specifying a constructor callback for creating the ContextManager instance.
countMetric⚓︎ string insights_trace_count x

Name of span hit counter metric, set to null to disable.
defaultFilters⚓︎ SpanFilter[] x x

This property is for internal use only.
defaults⚓︎ SpanCreationOptions x x

Default settings if appropriate entries aren't found in 'filters' and 'sampling' collections.
durationMetric⚓︎ string insights_trace_duration x

Name of span duration histogram metric, set to null to disable.
enabled⚓︎ boolean false

Whether tracing functionality is enabled. If disabled, API is still usable, but methods are no-ops.
exporterSettings⚓︎ OTLPExporterNodeConfigBase x x

If an OTEL TraceProvider isn't provided to the library, it will initialize its own.

If 'url' is specified, TracerProvider will have an OTLPTraceExporter with 'url' as detination URL and 'exporterSettings' as additional config.
filters⚓︎ SpanFilter[] x x

Array of filter entries used to determine whether a particular operation will create a tracing span, and what verbosity level will apply to attributes added to that span.

If no matching filter entry is found, the settings from 'default' are used.
headers⚓︎ { [x: string]: string } | (() => { [x: string]: string }) x x

Additional headers to send in HTTP requests, e.g. when using HTTP exporters.
hybridContextMode⚓︎ boolean false x

If true, the library will use both the ContextManager provided by the OTEL SDK and the Traces.currentTracingState property to resolve the current context. See the documentation of the useOTELContextManager property for more details.
instrumentAppLoad⚓︎ boolean true x

If true, io.Insights will instrument and trace the application loading process automatically.
instrumentDocumentLoad⚓︎ boolean true x

If true, io.Insights will instrument and trace the steps of the document load and initialization process automatically
instrumentRequests⚓︎ boolean true x

If true, io.Insights will instrument and trace XMLHttpRequest and fetch() requests automatically.
keepAlive⚓︎ boolean true x

Whether to keep the connection alive when sending traces.
otlpExporterConfig⚓︎ OTLPExporterNodeConfigBase x x x
parentNameLimit⚓︎ number x x

Maximum length for parent operation names in span hierarchies.
processorSettings⚓︎ BatchSpanProcessorBrowserConfig x x

Configuration for the batch span processor buffer settings.
propagator⚓︎ (tracesSettings: TracesSettings, settings: Settings) => TextMapPropagator x x

Allows specifying a constructor callback for creating the TextMapPropagator instance.
publishInterval⚓︎ number x x

Interval in milliseconds between trace export batches.
resultMetric⚓︎ string insights_trace_result x

Name of span result counter metric, set to null to disable.
rootPropagationInfo⚓︎ PropagationInfo x x

Property for internal use.
sampler⚓︎ (defaultSampler: Sampler, tracesSettings: TracesSettings, settings: Settings) => Sampler x x

Allows specifying a constructor callback for creating the Sampler instance.
sampling⚓︎ SamplingSettings[] x x

Array of sampling setting entries used to determine whether a span will be sampled.

If no matching sampling setting entry is found, the settings from 'defaults' are used.
spanExporters⚓︎ (exporterSettings: OTLPExporterNodeConfigBase, tracesSettings: TracesSettings, settings: Settings) => SpanExporter[] x x

Allows specifying a constructor callback for creating the SpanExporter instances.
spanProcessors⚓︎ (processorSettings: BatchSpanProcessorBrowserConfig | undefined, exporterSettings: OTLPExporterNodeConfigBase, tracesSettings: TracesSettings, settings: Settings) => SpanProcessor[] x x

Allows specifying a constructor callback for creating the SpanProcessor instances.
startupParentSpanTimeoutMs⚓︎ number x x

How long after application startup will any traced operations automatically be nested under the application startup trace.
timeoutMillis⚓︎ number 10000ms. x

Maximum time the OTLP exporter will wait for each batch export.
tracerProvider⚓︎ (tracerProviderSettings: TracerConfig, tracesSettings: TracesSettings, settings: Settings) => TracerProvider x x

Allows specifying a constructor callback for creating the tracerProvider instance.
tracerProviderSettings⚓︎ TracerConfig x x

OTEL TracerConfig - provides an interface for configuring a Basic Tracer.
url⚓︎ string x x

If an OTEL TraceProvider isn't provided to the library, it will initialize its own.

If 'url' is specified, TracerProvider will have an OTLPTraceExporter using this destination URL.
useDefaultFilters⚓︎ boolean true. x

If true, use a predefined list of filters for well-known platform traces.
useOTELContextManager⚓︎ boolean false x

If true, the library will use the ContextManager provided by the active OTEL SDK to manage and derive propagation information to ensure spans created across asynchronous operations are properly nested.

Otherwise, use Traces.currentTracingState to set and retrieve propagation info across asynchronous operations manually.

See https://opentelemetry.io/docs/languages/js/propagation/ and https://opentelemetry.io/docs/languages/js/context/#context-manager for more information.
userJourney⚓︎ boolean | "nested" | "sibling" | UserJourneyTraceConfig true x

Whether the user journey trace will be enabled. false - User Journey trace is disabled. nested - User Journey trace is enabled and each subsequent span is a child span of the previous one. sibling - User Journey trace is enabled and each subsequent span is a child of the same initial span.
useSSOAuth⚓︎ boolean false x

If true, use io.Connect's SSO login information when making requests to the OTEL collector.
useSSOAuthRawToken⚓︎ boolean true x

Used if io.Connect's SSO login information contains a token property. If true, the token property will be used as-is. If false, the token property may be prepended with the string "Bearer ", if it does not contain an Authorization type prefix.