@interopio/desktop API Reference

Properties (22)

Property Type Default Required Description
addContextToTrace⚓︎ boolean true x

Whether the filtering context will be added as span attributes to the span. See 'Filter'.
autoSetSuccessStatus⚓︎ boolean false x

Whether the span's status will be set to OK on completion, if it's still UNSET. See 'Filter'.
canBeRoot⚓︎ boolean true x

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.
countMetric⚓︎ boolean false x

Whether the span will be counted in the insights_trace_count metric. See TracesSettings.countMetric.
countMetricOnDisabledSpans⚓︎ boolean x x

Whether the span will be counted in the insights_trace_count metric if disabled. See TracesSettings.countMetric.
disableNesting⚓︎ boolean x x

Forces the span to create a new trace.
disablePropagation⚓︎ boolean false x

Whether the span will not inject its propagation info into data transfer objects for span nesting across system boundaries.
durationMetric⚓︎ boolean false x

Whether the span will be counted in the insights_trace_duration metric. See TracesSettings.durationtMetric.
durationMetricOnDisabledSpans⚓︎ boolean x x

Whether the span will be counted in the insights_trace_count metric if disabled. See TracesSettings.durationMetric.
enabled⚓︎ boolean true x

Whether the span will be created or will be a no-op. See 'Filter'.
forceChildTracing⚓︎ boolean false x

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.
level⚓︎ keyof typeof SpanVerbosity INFO x

Default span attribute verbosity level. See 'Filter'.
log⚓︎ boolean x x

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

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

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

Defaults to 3.
minDurationMs⚓︎ number x x

If specified, spans whose duration is lower than this will not be sampled.
otelSpanOptions⚓︎ SpanOptions x x

OTEL span options
overrideDefaultFilters⚓︎ boolean false x

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.
resultMetric⚓︎ boolean false x

Whether the span will be counted in the insights_trace_result metric. See TracesSettings.resultMetric.
resultMetricOnDisabledSpans⚓︎ boolean x x

Whether the span will be counted in the insights_trace_result metric if disabled. See TracesSettings.resultMetric.
sample⚓︎ number | boolean true x

Default sampling setting/probability. See 'SamplingSettings'.
stopPropagationIfSpanIsDisabled⚓︎ boolean x x

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