@interopio/otel 0.0.220 → 0.0.221

package/insights.d.ts

@@ -48,6 +48,9 @@ import { deprecate } from "util";
  * io.Insights API.
  */
 export namespace IOInsights {
+  /**
+   * Entry point into the io.Insights API
+   */
   export interface API extends Manager<Settings> {
     /**
      * io.insights Metrics API, often accessible as io.insights.metrics
@@ -63,10 +66,15 @@ export namespace IOInsights {
      * io.insights Logs API, often accessible as io.insights.logs
      */
     logs: LogsManager;
+
+    /**
+     * io.Insights settings
+     */
+    settings: Settings;
   }
 
   /**
-   * Builder interface for constructing the IO.Insights API.
+   * Builder interface for constructing the io.Insights API.
    */
   export interface APIBuilder {
     /**
@@ -126,6 +134,10 @@ export namespace IOInsights {
    * Metrics API.
    */
   export interface MetricsManager extends Manager<MetricsSettings> {
+    /**
+     * Metrics settings.
+     */
+    settings: MetricsSettings;
     /**
      * Creates or retrieves a metric by name.
      *
@@ -358,6 +370,9 @@ export namespace IOInsights {
     exporterSettings?: (OTLPExporterNodeConfigBase & OTLPMetricExporterOptions);
   }
 
+  /**
+   * Settings describing a metric.
+   */
   export interface MetricSettings {
     enabled: boolean;
     type: MetricType;
@@ -530,7 +545,7 @@ export namespace IOInsights {
        * Indicates whether the metric includes the time to create and load the Workspace Frame App when the workspace is opened in a new frame.
        */
       includesFrameCreation?: boolean;
-    };
+    } & Record<string, any>;
     /**
      * Whether or not the value for the matching metric will be published.
      */
@@ -844,6 +859,10 @@ export namespace IOInsights {
    * Traces API.
    */
   export interface TracesManager extends Manager<TracesSettings> {
+    /**
+     * Traces settings.
+     */
+    settings: TracesSettings;
     /**
      * The tracing state representing the currently active trace and span, if any.
      */
@@ -1161,19 +1180,19 @@ export namespace IOInsights {
     /**
      * Name of span hit counter metric, set to null to disable.
      *
-     * Defaults to 'insights_trace_count'.
+     * @default insights_trace_count
      */
     countMetric?: string;
     /**
      * Name of span duration histogram metric, set to null to disable.
      *
-     * Defaults to 'insights_trace_duration'.
+     * @default insights_trace_duration
      */
     durationMetric?: string;
     /**
      * Name of span result counter metric, set to null to disable.
      *
-     * Defaults to 'insights_trace_result'.
+     * @default insights_trace_result
      */
     resultMetric?: string;
 
@@ -1354,12 +1373,6 @@ export namespace IOInsights {
      */
     processorSettings?: BatchSpanProcessorBrowserConfig;
 
-    /**
-     * Configuration for automatic instrumentation of common browser operations.
-     * Enables automatic tracing of document load, user interactions, fetch requests, and XHR calls.
-     */
-    autoInstrumentations?: AutoInstrumentationOptions;
-
     /**
      * Maximum length for parent operation names in span hierarchies.
      */
@@ -1464,6 +1477,7 @@ export namespace IOInsights {
     __interopIOTracePropagationInfo?: PropagationInfo;
   }
 
+  /** @ignore */
   export type PropagationInfoCallback = (
     source: string,
     fullFilteringContext: FilteringContext
@@ -1508,7 +1522,7 @@ export namespace IOInsights {
     /**
      * Whether the span will be created or will be a no-op. See 'Filter'.
      *
-     * Defaults to 'true'.
+     * @default true
      */
     enabled?: boolean;
     /**
@@ -1519,34 +1533,34 @@ export namespace IOInsights {
     /**
      * Default span attribute verbosity level. See 'Filter'.
      *
-     * Defaults to 'INFO'.
+     * @default INFO
      */
     level?: keyof typeof SpanVerbosity;
     /**
      * Whether the filtering context will be added as span attributes
      * to the span. See 'Filter'.
      *
-     * Defaults to 'true'.
+     * @default true
      */
     addContextToTrace?: boolean;
     /**
      * Whether the span's status will be set to OK on completion, if
      * it's still UNSET. See 'Filter'.
      *
-     * Defaults to 'false'.
+     * @default false
      */
     autoSetSuccessStatus?: boolean;
     /**
      * Default sampling setting/probability. See 'SamplingSettings'.
      *
-     * Defaults to 'true'.
+     * @default true
      */
     sample?: number | boolean;
     /**
      * Whether the span will not inject its propagation info into data
      * transfer objects for span nesting across system boundaries.
      *
-     * Defaults to 'false'.
+     * @default false
      */
     disablePropagation?: boolean;
     /**
@@ -1569,7 +1583,7 @@ export namespace IOInsights {
     /**
      * Whether the span will be counted in the insights_trace_count metric. See TracesSettings.countMetric.
      *
-     * Defaults to 'false'.
+     * @default false
      */
     countMetric?: boolean;
     /**
@@ -1579,7 +1593,7 @@ export namespace IOInsights {
     /**
      * Whether the span will be counted in the insights_trace_result metric. See TracesSettings.resultMetric.
      *
-     * Defaults to 'false'.
+     * @default false
      */
     resultMetric?: boolean;
     /**
@@ -1589,7 +1603,7 @@ export namespace IOInsights {
     /**
      * Whether the span will be counted in the insights_trace_duration metric. See TracesSettings.durationtMetric.
      *
-     * Defaults to 'false'.
+     * @default false
      */
     durationMetric?: boolean;
     /**
@@ -1600,7 +1614,7 @@ export namespace IOInsights {
      * 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'.
+     * @default true
      */
     canBeRoot?: boolean;
     /**
@@ -1615,7 +1629,7 @@ export namespace IOInsights {
      * will be forced to be traced, even if their span filter configuration
      * is set to not enabled.
      *
-     * Defaults to 'false'.
+     * @default false
      */
     forceChildTracing?: boolean;
     /**
@@ -1669,17 +1683,6 @@ export namespace IOInsights {
     };
   }
 
-  // /**
-  //  * Configuration for automatic instrumentation of common browser operations.
-  //  * Enables automatic tracing of document load, user interactions, fetch requests, and XHR calls.
-  //  */ 
-  // export interface AutoInstrumentationOptions {
-  //   documentLoad?: boolean | DocumentLoadInstrumentationConfig;
-  //   userInteraction?: boolean | UserInteractionInstrumentationConfig;
-  //   fetch?: boolean | FetchInstrumentationConfig;
-  //   xhr?: boolean | XMLHttpRequestInstrumentationConfig;
-  //   ignoreObservabilityUrls?: boolean;
-  // }
   /**
    * Settings used to control the sampling probability of spans.
    */
@@ -1840,6 +1843,14 @@ export namespace IOInsights {
    * Logs API.
    */
   export interface LogsManager extends Manager<LogsSettings> {
+    /**
+     * Logs settings.
+     */
+    settings: LogsSettings;
+
+    /**
+     * Publishes an OTEL log record.
+     */
     emit(logRecord: LogRecord): Promise<void> | null;
   }
   /**
@@ -1929,7 +1940,7 @@ export namespace IOInsights {
     /**
      * Name of log level counter metric, set to null to disable.
      *
-     * Defaults to 'insights_log_level_count'.
+     * @default insights_log_level_count
      */
     levelCountMetric?: string;
 
@@ -2077,11 +2088,28 @@ export namespace IOInsights {
   }
 
   export interface Manager<TSettings> {
+    /**
+     * io.Insights settings.
+     */
     settings: TSettings;
+    /**
+     * Whether or not this instance is started.
+     */
     started: boolean;
-
+    /**
+     * Starts publishing data.
+     */
     start(): Promise<void>;
+    /**
+     * Stops publishing data.
+     */
     stop(): Promise<void>;
+
+    /**
+     * Waits for any pending data to be published, with the option to specify a timeout.
+     *
+     * @param timeoutMs maximum time to wait for export
+     */
     waitForFinalExport(timeoutMs?: number): Promise<void>;
   }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@interopio/otel",
-  "version": "0.0.220",
+  "version": "0.0.221",
   "description": "io.Insights observability library",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",