# Insights

**Kind**: module | **Library**: @interopio/desktop | **Access**: `io.insights`

**Source**: https://docs.interop.io/desktop/reference/javascript/insights/index.html

io.Insights API.

## Interfaces

- [API](https://docs.interop.io/desktop/reference/javascript/insights/api/index.md): Entry point into the io.Insights API
- [APIBuilder](https://docs.interop.io/desktop/reference/javascript/insights/apibuilder/index.md): Builder interface for constructing the io.Insights API.
- [AttributeData](https://docs.interop.io/desktop/reference/javascript/insights/attributedata/index.md): Interface for structured attribute data attached to spans, metrics, or log entries.
- [ClickstreamTraceConfig](https://docs.interop.io/desktop/reference/javascript/insights/clickstreamtraceconfig/index.md): Configuration for Clickstream trace behavior.
- [IncrementalMetric](https://docs.interop.io/desktop/reference/javascript/insights/incrementalmetric/index.md): Base interface for non-observable metrics with incremental values, such as Counter and UpDownCounter.
- [InstanceErrorHandlerArgs](https://docs.interop.io/desktop/reference/javascript/insights/instanceerrorhandlerargs/index.md)
- [Log4JSToOTELAppenderConfig](https://docs.interop.io/desktop/reference/javascript/insights/log4jstootelappenderconfig/index.md): This interface describes the log4js appender configuration that controls the
- [LogFilter](https://docs.interop.io/desktop/reference/javascript/insights/logfilter/index.md): Used to match and control publishing of log entries.
- [Logger](https://docs.interop.io/desktop/reference/javascript/insights/logger/index.md): Log interface that can be passed to library for its own logging.
- [LogOptions](https://docs.interop.io/desktop/reference/javascript/insights/logoptions/index.md)
- [LogsManager](https://docs.interop.io/desktop/reference/javascript/insights/logsmanager/index.md): Logs API.
- [LogsManagerBuilder](https://docs.interop.io/desktop/reference/javascript/insights/logsmanagerbuilder/index.md): Builder class used to set up Logs module.
- [LogsSettings](https://docs.interop.io/desktop/reference/javascript/insights/logssettings/index.md)
- [Manager](https://docs.interop.io/desktop/reference/javascript/insights/manager/index.md)
- [Metric](https://docs.interop.io/desktop/reference/javascript/insights/metric/index.md): Base interface for all metrics.
- [MetricAttributeSettings](https://docs.interop.io/desktop/reference/javascript/insights/metricattributesettings/index.md): Controls the publishing of specific attributes.
- [MetricDefaultFilter](https://docs.interop.io/desktop/reference/javascript/insights/metricdefaultfilter/index.md): Metric filters that can be specified as default.
- [MetricFilter](https://docs.interop.io/desktop/reference/javascript/insights/metricfilter/index.md): Metric filters that can be specified as part of a specific metric.
- [MetricPublishingSettings](https://docs.interop.io/desktop/reference/javascript/insights/metricpublishingsettings/index.md): Controls the publishing of the metric.
- [MetricSettings](https://docs.interop.io/desktop/reference/javascript/insights/metricsettings/index.md): Settings describing a metric.
- [MetricsManager](https://docs.interop.io/desktop/reference/javascript/insights/metricsmanager/index.md): Metrics API.
- [MetricsManagerBuilder](https://docs.interop.io/desktop/reference/javascript/insights/metricsmanagerbuilder/index.md): Builder class used to set up Metrics module.
- [MetricsSettings](https://docs.interop.io/desktop/reference/javascript/insights/metricssettings/index.md)
- [PropagationInfo](https://docs.interop.io/desktop/reference/javascript/insights/propagationinfo/index.md): Span and trace information that can be used to manually control the
- [RecordingMetric](https://docs.interop.io/desktop/reference/javascript/insights/recordingmetric/index.md): Base interface for non-observable metrics with independent values, such as Gauge and Histogram.
- [RequestTraceConfig](https://docs.interop.io/desktop/reference/javascript/insights/requesttraceconfig/index.md)
- [SamplingSettings](https://docs.interop.io/desktop/reference/javascript/insights/samplingsettings/index.md): Settings used to control the sampling probability of spans.
- [Settings](https://docs.interop.io/desktop/reference/javascript/insights/settings/index.md)
- [SpanCreationOptions](https://docs.interop.io/desktop/reference/javascript/insights/spancreationoptions/index.md)
- [SpanFilter](https://docs.interop.io/desktop/reference/javascript/insights/spanfilter/index.md): Filter entry that can match a span to control its settings.
- [SpanStatus](https://docs.interop.io/desktop/reference/javascript/insights/spanstatus/index.md)
- [TracesManager](https://docs.interop.io/desktop/reference/javascript/insights/tracesmanager/index.md): Traces API.
- [TracesManagerBuilder](https://docs.interop.io/desktop/reference/javascript/insights/tracesmanagerbuilder/index.md): Builder class used to set up Traces module.
- [TracesSettings](https://docs.interop.io/desktop/reference/javascript/insights/tracessettings/index.md)
- [TracingState](https://docs.interop.io/desktop/reference/javascript/insights/tracingstate/index.md)
- [UserJourneyTraceConfig](https://docs.interop.io/desktop/reference/javascript/insights/userjourneytraceconfig/index.md): Configuration for User Journey trace behavior.
- [WithSpanDecoratorOptions](https://docs.interop.io/desktop/reference/javascript/insights/withspandecoratoroptions/index.md): Options that can be provided when using `withSpan` as a decorator
- [WithSpanOptions](https://docs.interop.io/desktop/reference/javascript/insights/withspanoptions/index.md): Options that can be used when creating a span.

## Enumerations

- [LoggerLogLevel](https://docs.interop.io/desktop/reference/javascript/insights/loggerloglevel/index.md): Level of log entry.
- [SpanStatusCode](https://docs.interop.io/desktop/reference/javascript/insights/spanstatuscode/index.md)
- [SpanVerbosity](https://docs.interop.io/desktop/reference/javascript/insights/spanverbosity/index.md): Verbosity level of a span. Controls how much information is added using `.addData()`.

## Type Aliases

- [AttributeArray](https://docs.interop.io/desktop/reference/javascript/insights/attributearray/index.md): Array type for span/log attributes that can contain primitive values or null/undefined.
- [DataByVerbosity](https://docs.interop.io/desktop/reference/javascript/insights/databyverbosity/index.md)
- [FilteringContext](https://docs.interop.io/desktop/reference/javascript/insights/filteringcontext/index.md): Key-value pair that can be used to match a span against a filter in the tracing filtering config.
- [MarkerSpanCallback](https://docs.interop.io/desktop/reference/javascript/insights/markerspancallback/index.md): Callback function type for creating marker spans in User Journey or Clickstream traces.
- [MetricsMeterProviderCreateFunc](https://docs.interop.io/desktop/reference/javascript/insights/metricsmeterprovidercreatefunc/index.md): Advanced usage. Allows overriding meterProvider and metricReaders instantiation
- [MetricType](https://docs.interop.io/desktop/reference/javascript/insights/metrictype/index.md)
- [TracingMap](https://docs.interop.io/desktop/reference/javascript/insights/tracingmap/index.md)
- [WithSpanCallback](https://docs.interop.io/desktop/reference/javascript/insights/withspancallback/index.md): Callback executed during a span. See `withSpan`