Insights

io.insights.logs

io.insights.metrics

io.insights.traces

Logger instance used by the builder and child managers.

Metrics manager builder instance.

Settings configuration for the API.

Traces manager builder instance.

If true, the Clickstream trace spans will be named interopio.api.clickstream.. If false, the Clickstream trace spans will be named interopio.api.clickstream.

Whether the Clickstream trace is enabled.

List of DOM event names to capture as Clickstream trace spans.

If true, io.Insights will try to nest spans from other event listeners for the same event under the Clickstream span. This is not guaranteed to always work due to specifics of how browsers execute event listeners, and will only work for listeners attached after io.Connect was initialized.

If sibling, all spans in the Clickstream trace will be nested under the same root span. This is useful when working with visualization interfaces that do not handle arbitrarily nested spans.

If nested, every span in the Clickstream trace will be nested under the previous span. This is useful for some kinds of querying.

log4js layout to use for structuring the log entries. If not specified, uses MessagePassThroughLayout.

Whether errors in the @interopio/log4js-otel bridge appender will be logged to the console.

Maximum number of log records to store in memory before the OTEL SDK has finished initializing. Use -1 for an infinite number.

Maximum duration of time to store log entries in memory before the OTEL SDK has finished initializing. Use -1 for an infinite duration.

If specified, any attributes missing from the list will be removed from the log entry before publishing it.

Used to match the text of the log entry.

Used to match the category of the log entry.

If false, the log entry will not be published.

If specified, the log entry will have text matching this regex replaced with asterisks.

Used to match the severity of the log entry.

If specified, any attributes missing from the list will be removed from the log entry before publishing it.

If false, the log entry will not be published.

If specified, the log entry will have text matching this regex replaced with asterisks.

Additional logs attributes to publish as part of each log entry, 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%).

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%).

Whether to add resource attributes to log entry attributes.

Compression algorithm to use when exporting logs.

Maximum number of concurrent logs export requests.

Default settings if appropriate entries aren't found in 'filters' collection.

Whether logging functionality is enabled. If disabled, API is still usable, but methods are no-ops.

Settings for the OTLP exporter used to send logs.

Array of filter entries used to determine whether a particular log entry will be emitted, and which attributes will be included.

If no matching filter entry is found, the settings from 'defaults' are used.

Additional headers to send in HTTP requests, e.g. when using HTTP exporters.

Whether to keep the connection alive when sending logs.

Name of log level counter metric, set to null to disable.

Defaults to 'insights_log_level_count'.

Log record exporters.

Logger provider instance.

Configuration for the logger provider.

Log record processors.

Maximum length for log attribute object nesting.

Settings for batching log records before export.

Interval in milliseconds between logs export batches.

How long after application startup will any log entries automatically be associated with the application startup trace.

Maximum time the OTLP exporter will wait for each batch export.

OTLP logs exporter endpoint URL.

If true, use a predefined list of filters for well-known platform logs.

If true, use io.Connect's SSO login information when making requests to the OTEL collector.

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.

If specified, the attribute value will be hashed and truncated to this length to reduce the modality of the published metrics. Set to 0 to drop the attribute entirely. Set to -1 to override any defaults.

Controls the publishing of specific attributes.

Additional metrics properties to publish as part of each metric, 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%).

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%).

Whether to add resource attributes to metric data point attributes.

Compression algorithm to use when exporting metrics.

Maximum number of concurrent metric export requests.

Default publishing settings for metrics.

Optional override for the dependency container providing platform-specific metric handlers.

Whether metrics functionality is enabled. If disabled, API is still usable, but methods are no-ops.

Options to use when creating the OTLPMetricExporter to use when exporting metrics.

Array of filter rules to determine which metrics should be collected and exported.

Additional headers to send in HTTP requests, e.g. when using HTTP exporters.

Hostname to include in exported metrics.

Whether to use HTTP keep-alive connections for metric exports.

Partial MetricsSettings for meter configuration.

Custom metric exporter implementations for pushing metrics.

Custom metric reader implementations for pushing metrics.

Array of individual metric configurations to collect.

Whether to enable automatic collection of platform-level metrics (CPU, memory, etc.).

Interval in milliseconds between metric export batches.

Options to use when creating the PeriodicExportingMetricReader to use when exporting metrics.

Maximum time the OTLP exporter will wait for each batch export.

The destination URL for exporting metrics via OTLP.

Whether to apply predefined default filters for platform metrics.

If true, workspace_startup will be published as the legacy histogram metric from the io.Insights beta releases.

If true, use io.Connect's SSO login information when making requests to the OTEL collector.

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.

Span attributes that determine if span will match this sampling setting entry. Useful e.g. for checking otel.library.name/otel.scope.name attribute to filter auto-instrumentated spans. Start strings with "#" for case-insensitive regex match.

Context values that determine if span will match this sampling setting entry. 'Context' here refers to the object returned from the 'contextGetter' callback at the time of sampling, not the OTEL context concept. This is useful for sampling based on the current client environment - current user, application, server node, time of day, etc. Start strings with "#" for case-insensitive regex match.

Span name to determine if span will match this sampling setting entry. Start string with "#" for case-insensitive regex match

Probability that span will be sampled, based on its traceId Spans from the same trace will always either all be sampled, or none will, provided they all have the same sampling probability. If true: will be sampled If false: will not be sampled If number between 0 and 1: has this probability of being sampled. Precision: 3 decimal digits

Additional properties to publish as part of each OpenTelemetry signal, 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?DefaultValue%).

Additional properties to publish as part of the OpenTelemetry resource definition for all OpenTelemetry signals, 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?DefaultValue%).

Whether to add resource attributes to signal attributes.

Application name to use in telemetry information. By default, it's populated by io.Connect.

Internal library property.

Whether library is enabled. If disabled, API is still usable, but methods are no-ops.

If true, the library will swallow all errors, instead of propagating them.

If failure to initialize library will throw upstream error.

Interval in milliseconds to wait for any remaining telemetry data to be published by any apps before proceeding with the platform shutdown.

Interval in milliseconds to wait for any remaining telemetry data to be exported during shutdown of the platform. This is the maximum awaiting interval and the platform may shutdown before it expires if all telemetry data has already been published.

Additional headers to send in HTTP requests, e.g. when using HTTP exporters.

If the library should log the settings used to initialize it.

Internal library property.

If provided, this value will be added to the metrics and span attributes and to the span filtering context (see 'filters' in TracesSettings).

Internal library property.

For Node applications: whether to attempt to request io.Insights settings from the platform when initializing;

If provided, this value will be added to the metrics and traces service.instance.id attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting.

If provided, this value will be added to the metrics and traces service.name attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting.

If provided, this value will be added to the metrics and traces service.version attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting. attribute.

Suppress double initialization warnings from the OTEL SDK.

If provided, this value will be added to the metrics and traces user.id attribute, unless an OTEL service object (e.g. TraceProvider) has been provided to the library with a different setting.

If true, use io.Connect's SSO login information when making requests to the OTEL collector.

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.

Whether the filtering context will be added as span attributes to the span. See 'Filter'.

Defaults to 'true'.

Whether the span's status will be set to OK on completion, if it's still UNSET. See 'Filter'.

Defaults to 'false'.

Whether the span will be able to start a new trace. If false, it will only be able to be added to an existing trace.

Defaults to 'true'.

Whether the span will be counted in the insights_trace_count metric. See TracesSettings.countMetric.

Defaults to 'false'.

Whether the span will be counted in the insights_trace_count metric if disabled. See TracesSettings.countMetric.

Forces the span to create a new trace.

Whether the span will not inject its propagation info into data transfer objects for span nesting across system boundaries.

Defaults to 'false'.

Whether the span will be counted in the insights_trace_duration metric. See TracesSettings.durationtMetric.

Defaults to 'false'.

Whether the span will be counted in the insights_trace_count metric if disabled. See TracesSettings.durationMetric.

Whether the span will be created or will be a no-op. See 'Filter'.

Defaults to 'true'.

If true, any child spans (including nested spans across sytem boundaries) will be forced to be traced, even if their span filter configuration is set to not enabled.

Defaults to 'false'.

Default span attribute verbosity level. See 'Filter'.

Defaults to 'INFO'.

If true, enabled spans will also be published as log entries using the traceLogger passed to the builder instance when building the Traces module.

If true, disabled spans will also be published as log entries using the traceLogger passed to the builder instance when building the Traces module.

How deep addData method should recurse into objects when adding attributes to spans.

Defaults to 3.

If specified, spans whose duration is lower than this will not be sampled.

OTEL span options

If true, this filter rule will be matched before any default filters provided by io.Connect. The default filters are usually meant to reduce verbosity by not tracing some internal operations by default, but you can use this property to force them to be traced. If false, default filters will be matched before this filtering rule.

Whether the span will be counted in the insights_trace_result metric. See TracesSettings.resultMetric.

Defaults to 'false'.

Whether the span will be counted in the insights_trace_result metric if disabled. See TracesSettings.resultMetric.

Default sampling setting/probability. See 'SamplingSettings'.

Defaults to 'true'.

If a tracing span is disabled by filter, setting this to "true" will stop the propagation of trace nesting info across it.

Specifies the filtering context values used for matching spans. Spans match only if all the values in this object match the context values returned by the context getter callback and the filteringContext config property.

Start strings with "#" for case-insensitive regex match.

Specifies the source string used for matching spans. Spans match only if their source equals this value, or if their source starts with '.' (e.g. my.api.foo starts with my.api).

Start string with "#" for case-insensitive regex match.

The status code of this message.

A developer-facing error message.

Optional callback function to programmatically create marker spans in the Clickstream trace. Allows applications to mark specific user interaction events beyond automatic click tracking (e.g., custom UI interactions, gesture events, programmatic actions).

The callback receives:

• source: A descriptive name for the marker (e.g., "user-swiped-left", "custom-button-action")
• data: Optional span data organized by verbosity level for detailed context

Returns either PropagationInfo to link the marker span to other traces, or void.

Works in conjunction with the clickstream setting to track detailed user interaction patterns.

Called by the application to signify that its startup has completed and no further spans should be nested under the startup trace.

Optional callback function to programmatically create marker spans in the User Journey trace. Allows applications to mark significant points in a user's journey through the application (e.g., navigation events, key user actions, milestone completions).

The callback receives:

• source: A descriptive name for the marker (e.g., "user-navigated-to-dashboard")
• data: Optional span data organized by verbosity level for detailed context

Returns either PropagationInfo to link the marker span to other traces, or void.

Works in conjunction with the userJourney setting to track the user's entire session flow.

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%).

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%).

Whether to add resource attributes to span attributes.

Configuration for automatic instrumentation of common browser operations. Enables automatic tracing of document load, user interactions, fetch requests, and XHR calls.

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.

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 algorithm to use when exporting trace.

Maximum number of concurrent trace export requests.

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

If 'console' is 'true', TracerProvider will have a ConsoleTraceExporter.

Name of span hit counter metric, set to null to disable.

Defaults to 'insights_trace_count'.

This property is for internal use only.

Default settings if appropriate entries aren't found in 'filters' and 'sampling' collections.

Name of span duration histogram metric, set to null to disable.

Defaults to 'insights_trace_duration'.

Whether tracing functionality is enabled. If disabled, API is still usable, but methods are no-ops.

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.

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.

Additional headers to send in HTTP requests, e.g. when using HTTP exporters.

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.

If true, io.Insights will instrument and trace the application loading process automatically.

If true, io.Insights will instrument and trace the steps of the document load and initialization process automatically

If true, io.Insights will instrument and trace XMLHttpRequest and fetch() requests automatically.

Whether to keep the connection alive when sending traces.

Maximum length for parent operation names in span hierarchies.

Configuration for the batch span processor buffer settings.

Interval in milliseconds between trace export batches.

Name of span result counter metric, set to null to disable.

Defaults to 'insights_trace_result'.

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.

How long after application startup will any traced operations automatically be nested under the application startup trace.

Maximum time the OTLP exporter will wait for each batch export.

OTEL TracerConfig - provides an interface for configuring a Basic Tracer.

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.

If true, use a predefined list of filters for well-known platform traces.

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.

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.

If true, use io.Connect's SSO login information when making requests to the OTEL collector.

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.

If false, this is a placeholder object, and all its methods are no-ops, with the possible exception of getPropagationInfo() and injectPropagationInfo()

Gets the propagation info for the current span (see https://www.w3.org/TR/trace-context/#tracestate-field)

Sets a hidden property in the object that can be used to restore propagation information after serialization and deserialization (see withSpan 'propagationInfo' argument and Traces.extractPropagationInfo() method).

List of events to instrument (like 'mousedown', 'touchend', 'play' etc). By default only 'click' event is instrumented.

Callback function called each time new span is being created. Return true to prevent span recording. You can also use this handler to enhance created span with extra attributes.

Minimum interval in milliseconds between capturing consecutive user interaction events. Used to throttle high-frequency interactions and reduce span volume.

If specified, this number of previously focused applications and their focus times will be added as attributes to the User Journey span. This is useful for some kinds of querying.

If true, the User Journey trace spans will be named interopio.desktop.userJourney... If false, the User Journey trace spans will be named interopio.api.userJourney.

Whether the User Journey trace is enabled.

If sibling, all spans in the User Journey trace will be nested under the same root span. This is useful when working with visualization interfaces that do not handle arbitrarily nested spans.

If nested, every span in the User Journey trace will be nested under the previous span. This is useful for some kinds of querying.

Indicates whether the workspace loading involved a complex operation where existing apps are added to a new workspace. This attribute can be used to filter out metrics.

Indicates whether the metric includes the time to create and load the Workspace Frame App when the workspace is opened in a new frame.

Indicates whether the workspace loading involved a complex operation where existing apps are added to a new workspace. This attribute can be used to filter out metrics.

Indicates whether the metric includes the time to create and load the Workspace Frame App when the workspace is opened in a new frame.

Indicates whether the workspace loading involved a complex operation where existing apps are added to a new workspace. This attribute can be used to filter out metrics.

Indicates whether the metric includes the time to create and load the Workspace Frame App when the workspace is opened in a new frame.

Indicates whether the workspace loading involved a complex operation where existing apps are added to a new workspace. This attribute can be used to filter out metrics.

Indicates whether the metric includes the time to create and load the Workspace Frame App when the workspace is opened in a new frame.