@azure/monitor-opentelemetry-exporter 1.0.0-beta.7 → 1.0.0-beta.9

package/types/monitor-opentelemetry-exporter.d.ts

@@ -1,12 +1,102 @@
+import { AggregationTemporality } from '@opentelemetry/sdk-metrics';
+import { Attributes } from '@opentelemetry/api';
+import { Context } from '@opentelemetry/api';
+import * as coreClient from '@azure/core-client';
 import { ExportResult } from '@opentelemetry/core';
+import { InstrumentType } from '@opentelemetry/sdk-metrics';
+import { Link } from '@opentelemetry/api';
+import { PushMetricExporter } from '@opentelemetry/sdk-metrics';
 import { ReadableSpan } from '@opentelemetry/sdk-trace-base';
+import { ResourceMetrics } from '@opentelemetry/sdk-metrics';
+import { Sampler } from '@opentelemetry/sdk-trace-base';
+import { SamplingResult } from '@opentelemetry/sdk-trace-base';
 import { SpanExporter } from '@opentelemetry/sdk-trace-base';
-import { TokenCredential } from '@azure/core-http';
+import { SpanKind } from '@opentelemetry/api';
+import { TokenCredential } from '@azure/core-auth';
+
+/** Optional parameters. */
+export declare interface ApplicationInsightsClientOptionalParams extends coreClient.ServiceClientOptions {
+    /** Breeze endpoint: https://dc.services.visualstudio.com */
+    host?: string;
+    /** Overrides client endpoint. */
+    endpoint?: string;
+}
+
+/**
+ * ApplicationInsightsSampler is responsible for the following:
+ * Implements same trace id hashing algorithm so that traces are sampled the same across multiple nodes
+ * Adds item count to span attribute if span is sampled (needed for ingestion service)
+ * @param samplingRatio - 0 to 1 value.
+ */
+export declare class ApplicationInsightsSampler implements Sampler {
+    private readonly _sampleRate;
+    private readonly _samplingRatio;
+    constructor(samplingRatio?: number);
+    /**
+     * Checks whether span needs to be created and tracked.
+     *
+     * @param context Parent Context which may contain a span.
+     * @param traceId of the span to be created. It can be different from the
+     *     traceId in the {@link SpanContext}. Typically in situations when the
+     *     span to be created starts a new trace.
+     * @param spanName of the span to be created.
+     * @param spanKind of the span to be created.
+     * @param attributes Initial set of SpanAttributes for the Span being constructed.
+     * @param links Collection of links that will be associated with the Span to
+     *     be created. Typically useful for batch operations.
+     * @returns a {@link SamplingResult}.
+     */
+    shouldSample(context: Context, traceId: string, spanName: string, spanKind: SpanKind, attributes: Attributes, links: Link[]): SamplingResult;
+    /**
+     * Return Sampler description
+     */
+    toString(): string;
+    private _getSamplingHashCode;
+}
+
+/**
+ * Azure Monitor OpenTelemetry Trace Exporter.
+ */
+export declare abstract class AzureMonitorBaseExporter {
+    /**
+     * Instrumentation key to be used for exported envelopes
+     */
+    protected _instrumentationKey: string;
+    private readonly _persister;
+    private readonly _sender;
+    private _numConsecutiveRedirects;
+    private _retryTimer;
+    private _endpointUrl;
+    private _batchSendRetryIntervalMs;
+    /**
+     * Exporter internal configuration
+     */
+    private readonly _options;
+    /**
+     * Initializes a new instance of the AzureMonitorBaseExporter class.
+     * @param AzureMonitorExporterOptions - Exporter configuration.
+     */
+    constructor(options?: AzureMonitorExporterOptions);
+    /**
+     * Persist envelopes to disk
+     */
+    private _persist;
+    /**
+     * Shutdown exporter
+     */
+    protected _shutdown(): Promise<void>;
+    /**
+     * Export envelopes
+     */
+    protected _exportEnvelopes(envelopes: TelemetryItem[]): Promise<ExportResult>;
+    private _sendFirstPersistedFile;
+    private _isNetworkError;
+}
 
 /**
  * Provides configuration options for AzureMonitorTraceExporter.
  */
-export declare interface AzureExporterConfig {
+export declare interface AzureMonitorExporterOptions extends ApplicationInsightsClientOptionalParams {
     /**
      * Azure Monitor Connection String, if not provided the exporter will try to use environment variable APPLICATIONINSIGHTS_CONNECTION_STRING
      * Ex: "InstrumentationKey=00000000-0000-0000-0000-000000000000;IngestionEndpoint=https://dc.services.visualstudio.com"
@@ -20,24 +110,66 @@ export declare interface AzureExporterConfig {
      * Azure Active Directory Credential
      */
     aadTokenCredential?: TokenCredential;
+    /**
+     * Directory to store retriable telemetry when it fails to export.
+     */
+    storageDirectory?: string;
+    /**
+     * Disable offline storage when telemetry cannot be exported.
+     */
+    disableOfflineStorage?: boolean;
+}
+
+/**
+ * Azure Monitor OpenTelemetry Metric Exporter.
+ */
+export declare class AzureMonitorMetricExporter extends AzureMonitorBaseExporter implements PushMetricExporter {
+    /**
+     * Flag to determine if Exporter is shutdown.
+     */
+    private _isShutdown;
+    /**
+     * Aggregation temporality.
+     */
+    private _aggregationTemporality;
+    /**
+     * Initializes a new instance of the AzureMonitorMetricExporter class.
+     * @param AzureExporterConfig - Exporter configuration.
+     */
+    constructor(options?: AzureMonitorExporterOptions);
+    /**
+     * Export OpenTelemetry resource metrics.
+     * @param metrics - Resource metrics to export.
+     * @param resultCallback - Result callback.
+     */
+    export(metrics: ResourceMetrics, resultCallback: (result: ExportResult) => void): Promise<void>;
+    /**
+     * Shutdown AzureMonitorMetricExporter.
+     */
+    shutdown(): Promise<void>;
+    /**
+     * Select aggregation temporality
+     */
+    selectAggregationTemporality(_instrumentType: InstrumentType): AggregationTemporality;
+    /**
+     * Force flush
+     */
+    forceFlush(): Promise<void>;
 }
 
 /**
  * Azure Monitor OpenTelemetry Trace Exporter.
  */
-export declare class AzureMonitorTraceExporter implements SpanExporter {
-    private readonly _persister;
-    private readonly _sender;
-    private _numConsecutiveRedirects;
-    private _retryTimer;
-    private readonly _options;
+export declare class AzureMonitorTraceExporter extends AzureMonitorBaseExporter implements SpanExporter {
+    /**
+     * Flag to determine if Exporter is shutdown.
+     */
+    private _isShutdown;
     /**
      * Initializes a new instance of the AzureMonitorTraceExporter class.
      * @param AzureExporterConfig - Exporter configuration.
      */
-    constructor(options?: AzureExporterConfig);
-    private _persist;
-    private exportEnvelopes;
+    constructor(options?: AzureMonitorExporterOptions);
     /**
      * Export OpenTelemetry spans.
      * @param spans - Spans to export.
@@ -48,8 +180,22 @@ export declare class AzureMonitorTraceExporter implements SpanExporter {
      * Shutdown AzureMonitorTraceExporter.
      */
     shutdown(): Promise<void>;
-    private _sendFirstPersistedFile;
-    private _isNetworkError;
+}
+
+/** Data struct to contain only C section with custom fields. */
+export declare interface MonitorBase {
+    /** Name of item (B section) if any. If telemetry data is derived straight from this, this should be null. */
+    baseType?: string;
+    /** The data payload for the telemetry request */
+    baseData?: MonitorDomain;
+}
+
+/** The abstract common base of all domains. */
+export declare interface MonitorDomain {
+    /** Describes unknown properties. The value of an unknown property can be of "any" type. */
+    [property: string]: any;
+    /** Schema version */
+    version: number;
 }
 
 /**
@@ -62,4 +208,26 @@ export declare enum ServiceApiVersion {
     V2 = "2020-09-15_Preview"
 }
 
+/** System variables for a telemetry item. */
+export declare interface TelemetryItem {
+    /** Envelope version. For internal use only. By assigning this the default, it will not be serialized within the payload unless changed to a value other than #1. */
+    version?: number;
+    /** Type name of telemetry data item. */
+    name: string;
+    /** Event date time when telemetry item was created. This is the wall clock time on the client when the event was generated. There is no guarantee that the client's time is accurate. This field must be formatted in UTC ISO 8601 format, with a trailing 'Z' character, as described publicly on https://en.wikipedia.org/wiki/ISO_8601#UTC. Note: the number of decimal seconds digits provided are variable (and unspecified). Consumers should handle this, i.e. managed code consumers should not use format 'O' for parsing as it specifies a fixed length. Example: 2009-06-15T13:45:30.0000000Z. */
+    time: Date;
+    /** Sampling rate used in application. This telemetry item represents 100 / sampleRate actual telemetry items. */
+    sampleRate?: number;
+    /** Sequence field used to track absolute order of uploaded events. */
+    sequence?: string;
+    /** The instrumentation key of the Application Insights resource. */
+    instrumentationKey?: string;
+    /** Key/value collection of context properties. See ContextTagKeys for information on available properties. */
+    tags?: {
+        [propertyName: string]: string;
+    };
+    /** Telemetry data item. */
+    data?: MonitorBase;
+}
+
 export { }

package/CHANGELOG.md

@@ -1,51 +0,0 @@
-# Release History
-
-## 1.0.0-beta.7 (2022-04-05)
-
-### Features Added
-
-- Added authentication support using @azure/identity TokenCredential.
-- Added file access control in Windows for retriable telemetry.
-
-## 1.0.0-beta.6 (2022-02-08)
-
-### Other Changes
-
-- Updated OpenTelemtry dependencies to their latest available versions.
-
-## 1.0.0-beta.5 (2021-10-05)
-
-### Bugs Fixed
-
-- Fixed issue with SDK version field not being populated correctly.
-
-### Other Changes
-
-- Updated mapping for Azure Monitor according to latest specs.
-
-## 1.0.0-beta.4 (2021-07-07)
-
-- Updating OpenTelemetry API to 1.0.0
-- Adding support for temporary and permanent redirect
-- Adding cleanup process for older temp files
-
-## 1.0.0-beta.3 (2021-02-10)
-
-- Rename package to `@azure/monitor-opentelemetry-exporter`
-- Added serviceApiVersion config
-- Open Telemetry dependency updates
-
-## 1.0.0-beta.2 (2021-01-20)
-
-- Ship the correct type declaration file
-
-## 1.0.0-beta.1 (2021-01-13)
-
-- OT Exporter retry when there are network issues
-- OpenTelemetry Exporter using Resources API to get service properties
-- Rename package to `@azure/opentelemetry-exporter-azure-monitor`
-- [BREAKING] Deprecate all configuration options except for `connectionString`
-- [BREAKING] Removed support for `TelemetryProcessor`
-- (internal) Migrate to autorest generated HttpClient and Envelope Interfaces
-- Migrate to Azure SDK for JS repository
-- Adds support for Event Hubs Distributed Tracing [#10575](https://github.com/Azure/azure-sdk-for-js/pull/10575)

package/dist-esm/src/generated/applicationInsightsClientContext.js

@@ -1,34 +0,0 @@
-/*
- * Copyright (c) Microsoft Corporation.
- * Licensed under the MIT License.
- *
- * Code generated by Microsoft (R) AutoRest Code Generator.
- * Changes may cause incorrect behavior and will be lost if the code is regenerated.
- */
-import * as coreClient from "@azure/core-client";
-export class ApplicationInsightsClientContext extends coreClient.ServiceClient {
-    /**
-     * Initializes a new instance of the ApplicationInsightsClientContext class.
-     * @param options The parameter options
-     */
-    constructor(options) {
-        // Initializing default values for options
-        if (!options) {
-            options = {};
-        }
-        const defaults = {
-            requestContentType: "application/json; charset=utf-8"
-        };
-        const packageDetails = `azsdk-js-monitor-opentelemetry-exporter/1.0.0-beta.7`;
-        const userAgentPrefix = options.userAgentOptions && options.userAgentOptions.userAgentPrefix
-            ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`
-            : `${packageDetails}`;
-        const optionsWithDefaults = Object.assign(Object.assign(Object.assign({}, defaults), options), { userAgentOptions: {
-                userAgentPrefix
-            }, baseUri: options.endpoint || "{Host}/v2.1" });
-        super(optionsWithDefaults);
-        // Assigning values to Constant parameters
-        this.host = options.host || "https://dc.services.visualstudio.com";
-    }
-}
-//# sourceMappingURL=applicationInsightsClientContext.js.map

package/dist-esm/src/generated/applicationInsightsClientContext.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"applicationInsightsClientContext.js","sourceRoot":"","sources":["../../../src/generated/applicationInsightsClientContext.ts"],"names":[],"mappings":"AAAA;;;;;;GAMG;AAEH,OAAO,KAAK,UAAU,MAAM,oBAAoB,CAAC;AAGjD,MAAM,OAAO,gCAAiC,SAAQ,UAAU,CAAC,aAAa;IAG5E;;;OAGG;IACH,YAAY,OAAiD;QAC3D,0CAA0C;QAC1C,IAAI,CAAC,OAAO,EAAE;YACZ,OAAO,GAAG,EAAE,CAAC;SACd;QACD,MAAM,QAAQ,GAA4C;YACxD,kBAAkB,EAAE,iCAAiC;SACtD,CAAC;QAEF,MAAM,cAAc,GAAG,sDAAsD,CAAC;QAC9E,MAAM,eAAe,GACnB,OAAO,CAAC,gBAAgB,IAAI,OAAO,CAAC,gBAAgB,CAAC,eAAe;YAClE,CAAC,CAAC,GAAG,OAAO,CAAC,gBAAgB,CAAC,eAAe,IAAI,cAAc,EAAE;YACjE,CAAC,CAAC,GAAG,cAAc,EAAE,CAAC;QAE1B,MAAM,mBAAmB,iDACpB,QAAQ,GACR,OAAO,KACV,gBAAgB,EAAE;gBAChB,eAAe;aAChB,EACD,OAAO,EAAE,OAAO,CAAC,QAAQ,IAAI,aAAa,GAC3C,CAAC;QACF,KAAK,CAAC,mBAAmB,CAAC,CAAC;QAE3B,0CAA0C;QAC1C,IAAI,CAAC,IAAI,GAAG,OAAO,CAAC,IAAI,IAAI,sCAAsC,CAAC;IACrE,CAAC;CACF","sourcesContent":["/*\n * Copyright (c) Microsoft Corporation.\n * Licensed under the MIT License.\n *\n * Code generated by Microsoft (R) AutoRest Code Generator.\n * Changes may cause incorrect behavior and will be lost if the code is regenerated.\n */\n\nimport * as coreClient from \"@azure/core-client\";\nimport { ApplicationInsightsClientOptionalParams } from \"./models\";\n\nexport class ApplicationInsightsClientContext extends coreClient.ServiceClient {\n  host: string;\n\n  /**\n   * Initializes a new instance of the ApplicationInsightsClientContext class.\n   * @param options The parameter options\n   */\n  constructor(options?: ApplicationInsightsClientOptionalParams) {\n    // Initializing default values for options\n    if (!options) {\n      options = {};\n    }\n    const defaults: ApplicationInsightsClientOptionalParams = {\n      requestContentType: \"application/json; charset=utf-8\"\n    };\n\n    const packageDetails = `azsdk-js-monitor-opentelemetry-exporter/1.0.0-beta.7`;\n    const userAgentPrefix =\n      options.userAgentOptions && options.userAgentOptions.userAgentPrefix\n        ? `${options.userAgentOptions.userAgentPrefix} ${packageDetails}`\n        : `${packageDetails}`;\n\n    const optionsWithDefaults = {\n      ...defaults,\n      ...options,\n      userAgentOptions: {\n        userAgentPrefix\n      },\n      baseUri: options.endpoint || \"{Host}/v2.1\"\n    };\n    super(optionsWithDefaults);\n\n    // Assigning values to Constant parameters\n    this.host = options.host || \"https://dc.services.visualstudio.com\";\n  }\n}\n"]}