@azure/opentelemetry-instrumentation-azure-sdk 1.0.0-beta.6 → 1.0.0-beta.8

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (129) hide show
  1. package/LICENSE +3 -3
  2. package/README.md +33 -36
  3. package/dist/browser/configuration.d.ts +21 -0
  4. package/dist/browser/configuration.d.ts.map +1 -0
  5. package/{dist-esm/src → dist/browser}/configuration.js +2 -2
  6. package/{dist-esm/src → dist/browser}/configuration.js.map +1 -1
  7. package/dist/browser/index.d.ts +3 -0
  8. package/dist/browser/index.d.ts.map +1 -0
  9. package/dist/browser/index.js +5 -0
  10. package/{dist-esm/src → dist/browser}/index.js.map +1 -1
  11. package/dist/browser/instrumentation-browser.d.mts.map +1 -0
  12. package/dist/browser/instrumentation-browser.mjs.map +1 -0
  13. package/dist/browser/instrumentation.d.ts +36 -0
  14. package/{dist-esm/src/instrumentation.browser.js → dist/browser/instrumentation.js} +5 -5
  15. package/dist/browser/instrumenter.d.ts +13 -0
  16. package/dist/browser/instrumenter.d.ts.map +1 -0
  17. package/{dist-esm/src → dist/browser}/instrumenter.js +4 -4
  18. package/dist/browser/instrumenter.js.map +1 -0
  19. package/dist/browser/logger.d.ts +5 -0
  20. package/dist/browser/logger.d.ts.map +1 -0
  21. package/{dist-esm/src → dist/browser}/logger.js +1 -1
  22. package/{dist-esm/src → dist/browser}/logger.js.map +1 -1
  23. package/dist/browser/package.json +3 -0
  24. package/dist/browser/spanWrapper.d.ts +20 -0
  25. package/dist/browser/spanWrapper.d.ts.map +1 -0
  26. package/dist/browser/spanWrapper.js +65 -0
  27. package/dist/browser/spanWrapper.js.map +1 -0
  28. package/dist/browser/transformations.d.ts +30 -0
  29. package/dist/browser/transformations.d.ts.map +1 -0
  30. package/{dist-esm/src → dist/browser}/transformations.js +4 -19
  31. package/dist/browser/transformations.js.map +1 -0
  32. package/dist/commonjs/configuration.d.ts +21 -0
  33. package/dist/commonjs/configuration.d.ts.map +1 -0
  34. package/dist/commonjs/configuration.js +35 -0
  35. package/dist/commonjs/configuration.js.map +1 -0
  36. package/dist/commonjs/index.d.ts +3 -0
  37. package/dist/commonjs/index.d.ts.map +1 -0
  38. package/dist/commonjs/index.js +8 -0
  39. package/dist/commonjs/index.js.map +1 -0
  40. package/{types/latest/opentelemetry-instrumentation-azure-sdk.d.ts → dist/commonjs/instrumentation.d.ts} +42 -52
  41. package/dist/commonjs/instrumentation.d.ts.map +1 -0
  42. package/dist/commonjs/instrumentation.js +59 -0
  43. package/dist/commonjs/instrumentation.js.map +1 -0
  44. package/dist/commonjs/instrumenter.d.ts +13 -0
  45. package/dist/commonjs/instrumenter.d.ts.map +1 -0
  46. package/dist/commonjs/instrumenter.js +51 -0
  47. package/dist/commonjs/instrumenter.js.map +1 -0
  48. package/dist/commonjs/logger.d.ts +5 -0
  49. package/dist/commonjs/logger.d.ts.map +1 -0
  50. package/dist/commonjs/logger.js +11 -0
  51. package/dist/commonjs/logger.js.map +1 -0
  52. package/dist/commonjs/package.json +3 -0
  53. package/dist/commonjs/spanWrapper.d.ts +20 -0
  54. package/dist/commonjs/spanWrapper.d.ts.map +1 -0
  55. package/dist/commonjs/spanWrapper.js +69 -0
  56. package/dist/commonjs/spanWrapper.js.map +1 -0
  57. package/dist/commonjs/transformations.d.ts +30 -0
  58. package/dist/commonjs/transformations.d.ts.map +1 -0
  59. package/dist/commonjs/transformations.js +55 -0
  60. package/dist/commonjs/transformations.js.map +1 -0
  61. package/{types/latest → dist/commonjs}/tsdoc-metadata.json +1 -1
  62. package/dist/esm/configuration.d.ts +21 -0
  63. package/dist/esm/configuration.d.ts.map +1 -0
  64. package/dist/esm/configuration.js +31 -0
  65. package/dist/esm/configuration.js.map +1 -0
  66. package/dist/esm/index.d.ts +3 -0
  67. package/dist/esm/index.d.ts.map +1 -0
  68. package/dist/esm/index.js +5 -0
  69. package/dist/esm/index.js.map +1 -0
  70. package/dist/esm/instrumentation.d.ts +42 -0
  71. package/dist/esm/instrumentation.d.ts.map +1 -0
  72. package/{dist-esm/src → dist/esm}/instrumentation.js +9 -7
  73. package/dist/esm/instrumentation.js.map +1 -0
  74. package/dist/esm/instrumenter.d.ts +13 -0
  75. package/dist/esm/instrumenter.d.ts.map +1 -0
  76. package/dist/esm/instrumenter.js +47 -0
  77. package/dist/esm/instrumenter.js.map +1 -0
  78. package/dist/esm/logger.d.ts +5 -0
  79. package/dist/esm/logger.d.ts.map +1 -0
  80. package/dist/esm/logger.js +8 -0
  81. package/dist/esm/logger.js.map +1 -0
  82. package/dist/esm/package.json +3 -0
  83. package/dist/esm/spanWrapper.d.ts +20 -0
  84. package/dist/esm/spanWrapper.d.ts.map +1 -0
  85. package/dist/esm/spanWrapper.js +65 -0
  86. package/dist/esm/spanWrapper.js.map +1 -0
  87. package/dist/esm/transformations.d.ts +30 -0
  88. package/dist/esm/transformations.d.ts.map +1 -0
  89. package/dist/esm/transformations.js +51 -0
  90. package/dist/esm/transformations.js.map +1 -0
  91. package/dist/react-native/configuration.d.ts +21 -0
  92. package/dist/react-native/configuration.d.ts.map +1 -0
  93. package/dist/react-native/configuration.js +31 -0
  94. package/dist/react-native/configuration.js.map +1 -0
  95. package/dist/react-native/index.d.ts +3 -0
  96. package/dist/react-native/index.d.ts.map +1 -0
  97. package/dist/react-native/index.js +5 -0
  98. package/dist/react-native/index.js.map +1 -0
  99. package/dist/react-native/instrumentation.d.ts +42 -0
  100. package/dist/react-native/instrumentation.d.ts.map +1 -0
  101. package/dist/react-native/instrumentation.js +54 -0
  102. package/dist/react-native/instrumentation.js.map +1 -0
  103. package/dist/react-native/instrumenter.d.ts +13 -0
  104. package/dist/react-native/instrumenter.d.ts.map +1 -0
  105. package/dist/react-native/instrumenter.js +47 -0
  106. package/dist/react-native/instrumenter.js.map +1 -0
  107. package/dist/react-native/logger.d.ts +5 -0
  108. package/dist/react-native/logger.d.ts.map +1 -0
  109. package/dist/react-native/logger.js +8 -0
  110. package/dist/react-native/logger.js.map +1 -0
  111. package/dist/react-native/package.json +3 -0
  112. package/dist/react-native/spanWrapper.d.ts +20 -0
  113. package/dist/react-native/spanWrapper.d.ts.map +1 -0
  114. package/dist/react-native/spanWrapper.js +65 -0
  115. package/dist/react-native/spanWrapper.js.map +1 -0
  116. package/dist/react-native/transformations.d.ts +30 -0
  117. package/dist/react-native/transformations.d.ts.map +1 -0
  118. package/dist/react-native/transformations.js +51 -0
  119. package/dist/react-native/transformations.js.map +1 -0
  120. package/package.json +72 -56
  121. package/dist/index.js +0 -252
  122. package/dist/index.js.map +0 -1
  123. package/dist-esm/src/index.js +0 -5
  124. package/dist-esm/src/instrumentation.browser.js.map +0 -1
  125. package/dist-esm/src/instrumentation.js.map +0 -1
  126. package/dist-esm/src/instrumenter.js.map +0 -1
  127. package/dist-esm/src/spanWrapper.js +0 -46
  128. package/dist-esm/src/spanWrapper.js.map +0 -1
  129. package/dist-esm/src/transformations.js.map +0 -1
package/dist/index.js DELETED
@@ -1,252 +0,0 @@
1
- 'use strict';
2
-
3
- Object.defineProperty(exports, '__esModule', { value: true });
4
-
5
- var logger$1 = require('@azure/logger');
6
- var instrumentation = require('@opentelemetry/instrumentation');
7
- var api = require('@opentelemetry/api');
8
- var core = require('@opentelemetry/core');
9
-
10
- // Copyright (c) Microsoft Corporation.
11
- // Licensed under the MIT license.
12
- /**
13
- * The \@azure/logger configuration for this package.
14
- */
15
- const logger = logger$1.createClientLogger("opentelemetry-instrumentation-azure-sdk");
16
-
17
- // Copyright (c) Microsoft Corporation.
18
- // Licensed under the MIT license.
19
- class OpenTelemetrySpanWrapper {
20
- constructor(span) {
21
- this._span = span;
22
- }
23
- setStatus(status) {
24
- if (status.status === "error") {
25
- if (status.error) {
26
- this._span.setStatus({ code: api.SpanStatusCode.ERROR, message: status.error.toString() });
27
- this.recordException(status.error);
28
- }
29
- else {
30
- this._span.setStatus({ code: api.SpanStatusCode.ERROR });
31
- }
32
- }
33
- else if (status.status === "success") {
34
- this._span.setStatus({ code: api.SpanStatusCode.OK });
35
- }
36
- }
37
- setAttribute(name, value) {
38
- if (value !== null && value !== undefined) {
39
- this._span.setAttribute(name, value);
40
- }
41
- }
42
- end() {
43
- this._span.end();
44
- }
45
- recordException(exception) {
46
- this._span.recordException(exception);
47
- }
48
- isRecording() {
49
- return this._span.isRecording();
50
- }
51
- /**
52
- * Allows getting the wrapped span as needed.
53
- * @internal
54
- *
55
- * @returns The underlying span
56
- */
57
- unwrap() {
58
- return this._span;
59
- }
60
- }
61
-
62
- // Copyright (c) Microsoft Corporation.
63
- // Licensed under the MIT license.
64
- const SDK_VERSION = "1.0.0-beta.6";
65
- /**
66
- * @internal
67
- *
68
- * Cached values of environment variables that were fetched.
69
- */
70
- const environmentCache = new Map();
71
- /**
72
- * Converts an environment variable to Boolean.
73
- * the strings "false" and "0" are treated as falsy values.
74
- *
75
- * @internal
76
- */
77
- function envVarToBoolean(key) {
78
- var _a;
79
- if (!environmentCache.has(key)) {
80
- loadEnvironmentVariable(key);
81
- }
82
- const value = ((_a = environmentCache.get(key)) !== null && _a !== void 0 ? _a : "").toLowerCase();
83
- return value !== "false" && value !== "0" && Boolean(value);
84
- }
85
- function loadEnvironmentVariable(key) {
86
- var _a;
87
- if (typeof process !== "undefined" && process.env) {
88
- const rawValue = (_a = process.env[key]) !== null && _a !== void 0 ? _a : process.env[key.toLowerCase()];
89
- environmentCache.set(key, rawValue);
90
- }
91
- }
92
-
93
- // Copyright (c) Microsoft Corporation.
94
- // Licensed under the MIT license.
95
- /**
96
- * Converts our TracingSpanKind to the corresponding OpenTelemetry SpanKind.
97
- *
98
- * By default it will return {@link SpanKind.INTERNAL}
99
- * @param tracingSpanKind - The core tracing {@link TracingSpanKind}
100
- * @returns - The OpenTelemetry {@link SpanKind}
101
- */
102
- function toOpenTelemetrySpanKind(tracingSpanKind) {
103
- const key = (tracingSpanKind || "internal").toUpperCase();
104
- return api.SpanKind[key];
105
- }
106
- /**
107
- * Converts core-tracing's TracingSpanLink to OpenTelemetry's Link
108
- *
109
- * @param spanLinks - The core tracing {@link TracingSpanLink} to convert
110
- * @returns A set of {@link Link}s
111
- */
112
- function toOpenTelemetryLinks(spanLinks = []) {
113
- return spanLinks.reduce((acc, tracingSpanLink) => {
114
- const spanContext = api.trace.getSpanContext(tracingSpanLink.tracingContext);
115
- if (spanContext) {
116
- acc.push({
117
- context: spanContext,
118
- attributes: toOpenTelemetrySpanAttributes(tracingSpanLink.attributes),
119
- });
120
- }
121
- return acc;
122
- }, []);
123
- }
124
- /**
125
- * Converts core-tracing's span attributes to OpenTelemetry attributes.
126
- *
127
- * @param spanAttributes - The set of attributes to convert.
128
- * @returns An {@link SpanAttributes} to set on a span.
129
- */
130
- function toOpenTelemetrySpanAttributes(spanAttributes) {
131
- const attributes = {};
132
- for (const key in spanAttributes) {
133
- // Any non-nullish value is allowed.
134
- if (spanAttributes[key] !== null && spanAttributes[key] !== undefined) {
135
- attributes[key] = spanAttributes[key];
136
- }
137
- }
138
- return attributes;
139
- }
140
- /**
141
- * Converts core-tracing span options to OpenTelemetry options.
142
- *
143
- * @param spanOptions - The {@link InstrumenterSpanOptions} to convert.
144
- * @returns An OpenTelemetry {@link SpanOptions} that can be used when creating a span.
145
- */
146
- function toSpanOptions(spanOptions) {
147
- const { spanAttributes, spanLinks, spanKind } = spanOptions || {};
148
- const attributes = toOpenTelemetrySpanAttributes(spanAttributes);
149
- const kind = toOpenTelemetrySpanKind(spanKind);
150
- const links = toOpenTelemetryLinks(spanLinks);
151
- return {
152
- attributes,
153
- kind,
154
- links,
155
- };
156
- }
157
-
158
- // Copyright (c) Microsoft Corporation.
159
- // Licensed under the MIT license.
160
- // While default propagation is user-configurable, Azure services always use the W3C implementation.
161
- const propagator = new core.W3CTraceContextPropagator();
162
- class OpenTelemetryInstrumenter {
163
- startSpan(name, spanOptions) {
164
- let ctx = (spanOptions === null || spanOptions === void 0 ? void 0 : spanOptions.tracingContext) || api.context.active();
165
- let span;
166
- if (envVarToBoolean("AZURE_TRACING_DISABLED")) {
167
- // disable only our spans but not any downstream spans
168
- span = api.trace.wrapSpanContext(api.INVALID_SPAN_CONTEXT);
169
- }
170
- else {
171
- // Create our span
172
- span = api.trace
173
- .getTracer(spanOptions.packageName, spanOptions.packageVersion)
174
- .startSpan(name, toSpanOptions(spanOptions), ctx);
175
- if (envVarToBoolean("AZURE_HTTP_TRACING_CHILDREN_DISABLED") &&
176
- name.toUpperCase().startsWith("HTTP")) {
177
- // disable downstream spans
178
- ctx = core.suppressTracing(ctx);
179
- }
180
- }
181
- return {
182
- span: new OpenTelemetrySpanWrapper(span),
183
- tracingContext: api.trace.setSpan(ctx, span),
184
- };
185
- }
186
- withContext(tracingContext, callback, ...callbackArgs) {
187
- return api.context.with(tracingContext, callback,
188
- /** Assume caller will bind `this` or use arrow functions */ undefined, ...callbackArgs);
189
- }
190
- parseTraceparentHeader(traceparentHeader) {
191
- return propagator.extract(api.context.active(), { traceparent: traceparentHeader }, api.defaultTextMapGetter);
192
- }
193
- createRequestHeaders(tracingContext) {
194
- const headers = {};
195
- propagator.inject(tracingContext || api.context.active(), headers, api.defaultTextMapSetter);
196
- return headers;
197
- }
198
- }
199
-
200
- // Copyright (c) Microsoft Corporation.
201
- // Licensed under the MIT license.
202
- /**
203
- * The instrumentation module for the Azure SDK. Implements OpenTelemetry's {@link Instrumentation}.
204
- */
205
- class AzureSdkInstrumentation extends instrumentation.InstrumentationBase {
206
- constructor(options = {}) {
207
- super("@azure/opentelemetry-instrumentation-azure-sdk", SDK_VERSION, Object.assign({}, options));
208
- }
209
- /**
210
- * Entrypoint for the module registration.
211
- *
212
- * @returns The patched \@azure/core-tracing module after setting its instrumenter.
213
- */
214
- init() {
215
- const result = new instrumentation.InstrumentationNodeModuleDefinition("@azure/core-tracing", ["^1.0.0-preview.14", "^1.0.0"], (moduleExports) => {
216
- if (typeof moduleExports.useInstrumenter === "function") {
217
- moduleExports.useInstrumenter(new OpenTelemetryInstrumenter());
218
- }
219
- return moduleExports;
220
- });
221
- // Needed to support 1.0.0-preview.14
222
- result.includePrerelease = true;
223
- return result;
224
- }
225
- }
226
- /**
227
- * Enables Azure SDK Instrumentation using OpenTelemetry for Azure SDK client libraries.
228
- *
229
- * When registered, any Azure data plane package will begin emitting tracing spans for internal calls
230
- * as well as network calls
231
- *
232
- * Example usage:
233
- * ```ts
234
- * const openTelemetryInstrumentation = require("@opentelemetry/instrumentation");
235
- * openTelemetryInstrumentation.registerInstrumentations({
236
- * instrumentations: [createAzureSdkInstrumentation()],
237
- * })
238
- * ```
239
- *
240
- * @remarks
241
- *
242
- * As OpenTelemetry instrumentations rely on patching required modules, you should register
243
- * this instrumentation as early as possible and before loading any Azure Client Libraries.
244
- */
245
- function createAzureSdkInstrumentation(options = {}) {
246
- return new AzureSdkInstrumentation(options);
247
- }
248
-
249
- exports.AzureSdkInstrumentation = AzureSdkInstrumentation;
250
- exports.createAzureSdkInstrumentation = createAzureSdkInstrumentation;
251
- exports.logger = logger;
252
- //# sourceMappingURL=index.js.map
package/dist/index.js.map DELETED
@@ -1 +0,0 @@
1
- {"version":3,"file":"index.js","sources":["../src/logger.ts","../src/spanWrapper.ts","../src/configuration.ts","../src/transformations.ts","../src/instrumenter.ts","../src/instrumentation.ts"],"sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { createClientLogger } from \"@azure/logger\";\n\n/**\n * The \\@azure/logger configuration for this package.\n */\nexport const logger = createClientLogger(\"opentelemetry-instrumentation-azure-sdk\");\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { Span, AttributeValue, SpanStatusCode } from \"@opentelemetry/api\";\nimport { SpanStatus, TracingSpan } from \"@azure/core-tracing\";\n\nexport class OpenTelemetrySpanWrapper implements TracingSpan {\n private _span: Span;\n\n constructor(span: Span) {\n this._span = span;\n }\n\n setStatus(status: SpanStatus): void {\n if (status.status === \"error\") {\n if (status.error) {\n this._span.setStatus({ code: SpanStatusCode.ERROR, message: status.error.toString() });\n this.recordException(status.error);\n } else {\n this._span.setStatus({ code: SpanStatusCode.ERROR });\n }\n } else if (status.status === \"success\") {\n this._span.setStatus({ code: SpanStatusCode.OK });\n }\n }\n\n setAttribute(name: string, value: unknown): void {\n if (value !== null && value !== undefined) {\n this._span.setAttribute(name, value as AttributeValue);\n }\n }\n\n end(): void {\n this._span.end();\n }\n\n recordException(exception: string | Error): void {\n this._span.recordException(exception);\n }\n\n isRecording(): boolean {\n return this._span.isRecording();\n }\n\n /**\n * Allows getting the wrapped span as needed.\n * @internal\n *\n * @returns The underlying span\n */\n unwrap(): Span {\n return this._span;\n }\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nexport const SDK_VERSION: string = \"1.0.0-beta.6\";\n\n/**\n * @internal\n *\n * Keys of known environment variables we look up.\n */\nexport type KnownEnvironmentKey = \"AZURE_HTTP_TRACING_CHILDREN_DISABLED\" | \"AZURE_TRACING_DISABLED\";\n\n/**\n * @internal\n *\n * Cached values of environment variables that were fetched.\n */\nexport const environmentCache = new Map<KnownEnvironmentKey, string | undefined>();\n\n/**\n * Converts an environment variable to Boolean.\n * the strings \"false\" and \"0\" are treated as falsy values.\n *\n * @internal\n */\nexport function envVarToBoolean(key: KnownEnvironmentKey): boolean {\n if (!environmentCache.has(key)) {\n loadEnvironmentVariable(key);\n }\n const value = (environmentCache.get(key) ?? \"\").toLowerCase();\n return value !== \"false\" && value !== \"0\" && Boolean(value);\n}\n\nfunction loadEnvironmentVariable(key: KnownEnvironmentKey): void {\n if (typeof process !== \"undefined\" && process.env) {\n const rawValue = process.env[key] ?? process.env[key.toLowerCase()];\n environmentCache.set(key, rawValue);\n }\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { InstrumenterSpanOptions, TracingSpanKind, TracingSpanLink } from \"@azure/core-tracing\";\nimport { Attributes, AttributeValue, Link, SpanKind, SpanOptions, trace } from \"@opentelemetry/api\";\n\n/**\n * Converts our TracingSpanKind to the corresponding OpenTelemetry SpanKind.\n *\n * By default it will return {@link SpanKind.INTERNAL}\n * @param tracingSpanKind - The core tracing {@link TracingSpanKind}\n * @returns - The OpenTelemetry {@link SpanKind}\n */\nexport function toOpenTelemetrySpanKind<K extends TracingSpanKind>(\n tracingSpanKind?: K,\n): SpanKindMapping[K] {\n const key = (tracingSpanKind || \"internal\").toUpperCase() as keyof typeof SpanKind;\n return SpanKind[key] as SpanKindMapping[K];\n}\n\n/**\n * A mapping between our {@link TracingSpanKind} union type and OpenTelemetry's {@link SpanKind}.\n */\ntype SpanKindMapping = {\n client: SpanKind.CLIENT;\n server: SpanKind.SERVER;\n producer: SpanKind.PRODUCER;\n consumer: SpanKind.CONSUMER;\n internal: SpanKind.INTERNAL;\n};\n\n/**\n * Converts core-tracing's TracingSpanLink to OpenTelemetry's Link\n *\n * @param spanLinks - The core tracing {@link TracingSpanLink} to convert\n * @returns A set of {@link Link}s\n */\nfunction toOpenTelemetryLinks(spanLinks: TracingSpanLink[] = []): Link[] {\n return spanLinks.reduce((acc, tracingSpanLink) => {\n const spanContext = trace.getSpanContext(tracingSpanLink.tracingContext);\n if (spanContext) {\n acc.push({\n context: spanContext,\n attributes: toOpenTelemetrySpanAttributes(tracingSpanLink.attributes),\n });\n }\n return acc;\n }, [] as Link[]);\n}\n\n/**\n * Converts core-tracing's span attributes to OpenTelemetry attributes.\n *\n * @param spanAttributes - The set of attributes to convert.\n * @returns An {@link SpanAttributes} to set on a span.\n */\nfunction toOpenTelemetrySpanAttributes(\n spanAttributes: { [key: string]: unknown } | undefined,\n): Attributes {\n const attributes: ReturnType<typeof toOpenTelemetrySpanAttributes> = {};\n for (const key in spanAttributes) {\n // Any non-nullish value is allowed.\n if (spanAttributes[key] !== null && spanAttributes[key] !== undefined) {\n attributes[key] = spanAttributes[key] as AttributeValue;\n }\n }\n return attributes;\n}\n\n/**\n * Converts core-tracing span options to OpenTelemetry options.\n *\n * @param spanOptions - The {@link InstrumenterSpanOptions} to convert.\n * @returns An OpenTelemetry {@link SpanOptions} that can be used when creating a span.\n */\nexport function toSpanOptions(spanOptions?: InstrumenterSpanOptions): SpanOptions {\n const { spanAttributes, spanLinks, spanKind } = spanOptions || {};\n\n const attributes: Attributes = toOpenTelemetrySpanAttributes(spanAttributes);\n const kind = toOpenTelemetrySpanKind(spanKind);\n const links = toOpenTelemetryLinks(spanLinks);\n\n return {\n attributes,\n kind,\n links,\n };\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n INVALID_SPAN_CONTEXT,\n Span,\n context,\n defaultTextMapGetter,\n defaultTextMapSetter,\n trace,\n} from \"@opentelemetry/api\";\nimport {\n Instrumenter,\n InstrumenterSpanOptions,\n TracingContext,\n TracingSpan,\n} from \"@azure/core-tracing\";\nimport { W3CTraceContextPropagator, suppressTracing } from \"@opentelemetry/core\";\n\nimport { OpenTelemetrySpanWrapper } from \"./spanWrapper\";\nimport { envVarToBoolean } from \"./configuration\";\nimport { toSpanOptions } from \"./transformations\";\n\n// While default propagation is user-configurable, Azure services always use the W3C implementation.\nexport const propagator = new W3CTraceContextPropagator();\n\nexport class OpenTelemetryInstrumenter implements Instrumenter {\n startSpan(\n name: string,\n spanOptions: InstrumenterSpanOptions,\n ): { span: TracingSpan; tracingContext: TracingContext } {\n let ctx = spanOptions?.tracingContext || context.active();\n let span: Span;\n\n if (envVarToBoolean(\"AZURE_TRACING_DISABLED\")) {\n // disable only our spans but not any downstream spans\n span = trace.wrapSpanContext(INVALID_SPAN_CONTEXT);\n } else {\n // Create our span\n span = trace\n .getTracer(spanOptions.packageName, spanOptions.packageVersion)\n .startSpan(name, toSpanOptions(spanOptions), ctx);\n\n if (\n envVarToBoolean(\"AZURE_HTTP_TRACING_CHILDREN_DISABLED\") &&\n name.toUpperCase().startsWith(\"HTTP\")\n ) {\n // disable downstream spans\n ctx = suppressTracing(ctx);\n }\n }\n\n return {\n span: new OpenTelemetrySpanWrapper(span),\n tracingContext: trace.setSpan(ctx, span),\n };\n }\n withContext<\n CallbackArgs extends unknown[],\n Callback extends (...args: CallbackArgs) => ReturnType<Callback>,\n >(\n tracingContext: TracingContext,\n callback: Callback,\n ...callbackArgs: CallbackArgs\n ): ReturnType<Callback> {\n return context.with(\n tracingContext,\n callback,\n /** Assume caller will bind `this` or use arrow functions */ undefined,\n ...callbackArgs,\n );\n }\n\n parseTraceparentHeader(traceparentHeader: string): TracingContext {\n return propagator.extract(\n context.active(),\n { traceparent: traceparentHeader },\n defaultTextMapGetter,\n );\n }\n\n createRequestHeaders(tracingContext?: TracingContext): Record<string, string> {\n const headers: Record<string, string> = {};\n propagator.inject(tracingContext || context.active(), headers, defaultTextMapSetter);\n return headers;\n }\n}\n","// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n Instrumentation,\n InstrumentationBase,\n InstrumentationConfig,\n InstrumentationModuleDefinition,\n InstrumentationNodeModuleDefinition,\n} from \"@opentelemetry/instrumentation\";\n\nimport { OpenTelemetryInstrumenter } from \"./instrumenter\";\nimport { SDK_VERSION } from \"./configuration\";\n\n/**\n * Configuration options that can be passed to {@link createAzureSdkInstrumentation} function.\n */\nexport interface AzureSdkInstrumentationOptions extends InstrumentationConfig {}\n\n/**\n * The instrumentation module for the Azure SDK. Implements OpenTelemetry's {@link Instrumentation}.\n */\nexport class AzureSdkInstrumentation extends InstrumentationBase {\n constructor(options: AzureSdkInstrumentationOptions = {}) {\n super(\n \"@azure/opentelemetry-instrumentation-azure-sdk\",\n SDK_VERSION,\n Object.assign({}, options),\n );\n }\n /**\n * Entrypoint for the module registration.\n *\n * @returns The patched \\@azure/core-tracing module after setting its instrumenter.\n */\n protected init(): void | InstrumentationModuleDefinition | InstrumentationModuleDefinition[] {\n const result: InstrumentationModuleDefinition = new InstrumentationNodeModuleDefinition(\n \"@azure/core-tracing\",\n [\"^1.0.0-preview.14\", \"^1.0.0\"],\n (moduleExports) => {\n if (typeof moduleExports.useInstrumenter === \"function\") {\n moduleExports.useInstrumenter(new OpenTelemetryInstrumenter());\n }\n\n return moduleExports;\n },\n );\n // Needed to support 1.0.0-preview.14\n result.includePrerelease = true;\n return result;\n }\n}\n\n/**\n * Enables Azure SDK Instrumentation using OpenTelemetry for Azure SDK client libraries.\n *\n * When registered, any Azure data plane package will begin emitting tracing spans for internal calls\n * as well as network calls\n *\n * Example usage:\n * ```ts\n * const openTelemetryInstrumentation = require(\"@opentelemetry/instrumentation\");\n * openTelemetryInstrumentation.registerInstrumentations({\n * instrumentations: [createAzureSdkInstrumentation()],\n * })\n * ```\n *\n * @remarks\n *\n * As OpenTelemetry instrumentations rely on patching required modules, you should register\n * this instrumentation as early as possible and before loading any Azure Client Libraries.\n */\nexport function createAzureSdkInstrumentation(\n options: AzureSdkInstrumentationOptions = {},\n): Instrumentation {\n return new AzureSdkInstrumentation(options);\n}\n"],"names":["createClientLogger","SpanStatusCode","SpanKind","trace","W3CTraceContextPropagator","context","INVALID_SPAN_CONTEXT","suppressTracing","defaultTextMapGetter","defaultTextMapSetter","InstrumentationBase","InstrumentationNodeModuleDefinition"],"mappings":";;;;;;;;;AAAA;AACA;AAIA;;AAEG;MACU,MAAM,GAAGA,2BAAkB,CAAC,yCAAyC;;ACRlF;AACA;MAKa,wBAAwB,CAAA;AAGnC,IAAA,WAAA,CAAY,IAAU,EAAA;AACpB,QAAA,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;KACnB;AAED,IAAA,SAAS,CAAC,MAAkB,EAAA;AAC1B,QAAA,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE;AAC7B,YAAA,IAAI,MAAM,CAAC,KAAK,EAAE;gBAChB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAEC,kBAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;AACvF,gBAAA,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;aACpC;iBAAM;AACL,gBAAA,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAEA,kBAAc,CAAC,KAAK,EAAE,CAAC,CAAC;aACtD;SACF;AAAM,aAAA,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE;AACtC,YAAA,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAEA,kBAAc,CAAC,EAAE,EAAE,CAAC,CAAC;SACnD;KACF;IAED,YAAY,CAAC,IAAY,EAAE,KAAc,EAAA;QACvC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE;YACzC,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,KAAuB,CAAC,CAAC;SACxD;KACF;IAED,GAAG,GAAA;AACD,QAAA,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;KAClB;AAED,IAAA,eAAe,CAAC,SAAyB,EAAA;AACvC,QAAA,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;KACvC;IAED,WAAW,GAAA;AACT,QAAA,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;KACjC;AAED;;;;;AAKG;IACH,MAAM,GAAA;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;KACnB;AACF;;ACrDD;AACA;AAEO,MAAM,WAAW,GAAW,cAAc,CAAC;AASlD;;;;AAIG;AACI,MAAM,gBAAgB,GAAG,IAAI,GAAG,EAA2C,CAAC;AAEnF;;;;;AAKG;AACG,SAAU,eAAe,CAAC,GAAwB,EAAA;;IACtD,IAAI,CAAC,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,EAAE;QAC9B,uBAAuB,CAAC,GAAG,CAAC,CAAC;KAC9B;AACD,IAAA,MAAM,KAAK,GAAG,CAAC,CAAA,EAAA,GAAA,gBAAgB,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,EAAE,EAAE,WAAW,EAAE,CAAC;AAC9D,IAAA,OAAO,KAAK,KAAK,OAAO,IAAI,KAAK,KAAK,GAAG,IAAI,OAAO,CAAC,KAAK,CAAC,CAAC;AAC9D,CAAC;AAED,SAAS,uBAAuB,CAAC,GAAwB,EAAA;;IACvD,IAAI,OAAO,OAAO,KAAK,WAAW,IAAI,OAAO,CAAC,GAAG,EAAE;AACjD,QAAA,MAAM,QAAQ,GAAG,CAAA,EAAA,GAAA,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,mCAAI,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,WAAW,EAAE,CAAC,CAAC;AACpE,QAAA,gBAAgB,CAAC,GAAG,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAC;KACrC;AACH;;ACtCA;AACA;AAKA;;;;;;AAMG;AACG,SAAU,uBAAuB,CACrC,eAAmB,EAAA;IAEnB,MAAM,GAAG,GAAG,CAAC,eAAe,IAAI,UAAU,EAAE,WAAW,EAA2B,CAAC;AACnF,IAAA,OAAOC,YAAQ,CAAC,GAAG,CAAuB,CAAC;AAC7C,CAAC;AAaD;;;;;AAKG;AACH,SAAS,oBAAoB,CAAC,SAAA,GAA+B,EAAE,EAAA;IAC7D,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,eAAe,KAAI;QAC/C,MAAM,WAAW,GAAGC,SAAK,CAAC,cAAc,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QACzE,IAAI,WAAW,EAAE;YACf,GAAG,CAAC,IAAI,CAAC;AACP,gBAAA,OAAO,EAAE,WAAW;AACpB,gBAAA,UAAU,EAAE,6BAA6B,CAAC,eAAe,CAAC,UAAU,CAAC;AACtE,aAAA,CAAC,CAAC;SACJ;AACD,QAAA,OAAO,GAAG,CAAC;KACZ,EAAE,EAAY,CAAC,CAAC;AACnB,CAAC;AAED;;;;;AAKG;AACH,SAAS,6BAA6B,CACpC,cAAsD,EAAA;IAEtD,MAAM,UAAU,GAAqD,EAAE,CAAC;AACxE,IAAA,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE;;AAEhC,QAAA,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE;YACrE,UAAU,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAmB,CAAC;SACzD;KACF;AACD,IAAA,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;AAKG;AACG,SAAU,aAAa,CAAC,WAAqC,EAAA;IACjE,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;AAElE,IAAA,MAAM,UAAU,GAAe,6BAA6B,CAAC,cAAc,CAAC,CAAC;AAC7E,IAAA,MAAM,IAAI,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;AAC/C,IAAA,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAE9C,OAAO;QACL,UAAU;QACV,IAAI;QACJ,KAAK;KACN,CAAC;AACJ;;ACvFA;AACA;AAsBA;AACO,MAAM,UAAU,GAAG,IAAIC,8BAAyB,EAAE,CAAC;MAE7C,yBAAyB,CAAA;IACpC,SAAS,CACP,IAAY,EACZ,WAAoC,EAAA;AAEpC,QAAA,IAAI,GAAG,GAAG,CAAA,WAAW,aAAX,WAAW,KAAA,KAAA,CAAA,GAAA,KAAA,CAAA,GAAX,WAAW,CAAE,cAAc,KAAIC,WAAO,CAAC,MAAM,EAAE,CAAC;AAC1D,QAAA,IAAI,IAAU,CAAC;AAEf,QAAA,IAAI,eAAe,CAAC,wBAAwB,CAAC,EAAE;;AAE7C,YAAA,IAAI,GAAGF,SAAK,CAAC,eAAe,CAACG,wBAAoB,CAAC,CAAC;SACpD;aAAM;;AAEL,YAAA,IAAI,GAAGH,SAAK;iBACT,SAAS,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,cAAc,CAAC;iBAC9D,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC;YAEpD,IACE,eAAe,CAAC,sCAAsC,CAAC;gBACvD,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EACrC;;AAEA,gBAAA,GAAG,GAAGI,oBAAe,CAAC,GAAG,CAAC,CAAC;aAC5B;SACF;QAED,OAAO;AACL,YAAA,IAAI,EAAE,IAAI,wBAAwB,CAAC,IAAI,CAAC;YACxC,cAAc,EAAEJ,SAAK,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC;SACzC,CAAC;KACH;AACD,IAAA,WAAW,CAIT,cAA8B,EAC9B,QAAkB,EAClB,GAAG,YAA0B,EAAA;AAE7B,QAAA,OAAOE,WAAO,CAAC,IAAI,CACjB,cAAc,EACd,QAAQ;AACR,qEAA6D,SAAS,EACtE,GAAG,YAAY,CAChB,CAAC;KACH;AAED,IAAA,sBAAsB,CAAC,iBAAyB,EAAA;AAC9C,QAAA,OAAO,UAAU,CAAC,OAAO,CACvBA,WAAO,CAAC,MAAM,EAAE,EAChB,EAAE,WAAW,EAAE,iBAAiB,EAAE,EAClCG,wBAAoB,CACrB,CAAC;KACH;AAED,IAAA,oBAAoB,CAAC,cAA+B,EAAA;QAClD,MAAM,OAAO,GAA2B,EAAE,CAAC;AAC3C,QAAA,UAAU,CAAC,MAAM,CAAC,cAAc,IAAIH,WAAO,CAAC,MAAM,EAAE,EAAE,OAAO,EAAEI,wBAAoB,CAAC,CAAC;AACrF,QAAA,OAAO,OAAO,CAAC;KAChB;AACF;;ACtFD;AACA;AAkBA;;AAEG;AACG,MAAO,uBAAwB,SAAQC,mCAAmB,CAAA;AAC9D,IAAA,WAAA,CAAY,UAA0C,EAAE,EAAA;AACtD,QAAA,KAAK,CACH,gDAAgD,EAChD,WAAW,EACX,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAC3B,CAAC;KACH;AACD;;;;AAIG;IACO,IAAI,GAAA;AACZ,QAAA,MAAM,MAAM,GAAoC,IAAIC,mDAAmC,CACrF,qBAAqB,EACrB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,EAC/B,CAAC,aAAa,KAAI;AAChB,YAAA,IAAI,OAAO,aAAa,CAAC,eAAe,KAAK,UAAU,EAAE;AACvD,gBAAA,aAAa,CAAC,eAAe,CAAC,IAAI,yBAAyB,EAAE,CAAC,CAAC;aAChE;AAED,YAAA,OAAO,aAAa,CAAC;AACvB,SAAC,CACF,CAAC;;AAEF,QAAA,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC;AAChC,QAAA,OAAO,MAAM,CAAC;KACf;AACF,CAAA;AAED;;;;;;;;;;;;;;;;;;AAkBG;AACa,SAAA,6BAA6B,CAC3C,OAAA,GAA0C,EAAE,EAAA;AAE5C,IAAA,OAAO,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAC9C;;;;;;"}
@@ -1,5 +0,0 @@
1
- // Copyright (c) Microsoft Corporation.
2
- // Licensed under the MIT license.
3
- export * from "./logger";
4
- export * from "./instrumentation";
5
- //# sourceMappingURL=index.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"instrumentation.browser.js","sourceRoot":"","sources":["../../src/instrumentation.browser.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAEL,mBAAmB,GAEpB,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAOtD;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,mBAAmB;IAC9D,YAAY,UAA0C,EAAE;QACtD,KAAK,CACH,gDAAgD,EAChD,WAAW,EACX,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAC3B,CAAC;IACJ,CAAC;IACD,2GAA2G;IACjG,IAAI;QACZ,QAAQ;IACV,CAAC;IAED;;OAEG;IACH,MAAM;QACJ,eAAe,CAAC,IAAI,yBAAyB,EAAE,CAAC,CAAC;IACnD,CAAC;IAED,OAAO;QACL,QAAQ;IACV,CAAC;CACF;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,UAAU,6BAA6B,CAC3C,UAA0C,EAAE;IAE5C,OAAO,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n Instrumentation,\n InstrumentationBase,\n InstrumentationConfig,\n} from \"@opentelemetry/instrumentation\";\n\nimport { OpenTelemetryInstrumenter } from \"./instrumenter\";\nimport { SDK_VERSION } from \"./configuration\";\nimport { useInstrumenter } from \"@azure/core-tracing\";\n\n/**\n * Configuration options that can be passed to {@link createAzureSdkInstrumentation} function.\n */\nexport interface AzureSdkInstrumentationOptions extends InstrumentationConfig {}\n\n/**\n * The instrumentation module for the Azure SDK. Implements OpenTelemetry's {@link Instrumentation}.\n */\nexport class AzureSdkInstrumentation extends InstrumentationBase {\n constructor(options: AzureSdkInstrumentationOptions = {}) {\n super(\n \"@azure/opentelemetry-instrumentation-azure-sdk\",\n SDK_VERSION,\n Object.assign({}, options),\n );\n }\n /** In the browser we rely on overriding the `enable` function instead as there are no modules to patch. */\n protected init(): void {\n // no-op\n }\n\n /**\n * Entrypoint for the module registration. Ensures the global instrumenter is set to use OpenTelemetry.\n */\n enable(): void {\n useInstrumenter(new OpenTelemetryInstrumenter());\n }\n\n disable(): void {\n // no-op\n }\n}\n\n/**\n * Enables Azure SDK Instrumentation using OpenTelemetry for Azure SDK client libraries.\n *\n * When registered, any Azure data plane package will begin emitting tracing spans for internal calls\n * as well as network calls\n *\n * Example usage:\n * ```ts\n * const openTelemetryInstrumentation = require(\"@opentelemetry/instrumentation\");\n * openTelemetryInstrumentation.registerInstrumentations({\n * instrumentations: [createAzureSdkInstrumentation()],\n * })\n * ```\n */\nexport function createAzureSdkInstrumentation(\n options: AzureSdkInstrumentationOptions = {},\n): Instrumentation {\n return new AzureSdkInstrumentation(options);\n}\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"file":"instrumentation.js","sourceRoot":"","sources":["../../src/instrumentation.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAEL,mBAAmB,EAGnB,mCAAmC,GACpC,MAAM,gCAAgC,CAAC;AAExC,OAAO,EAAE,yBAAyB,EAAE,MAAM,gBAAgB,CAAC;AAC3D,OAAO,EAAE,WAAW,EAAE,MAAM,iBAAiB,CAAC;AAO9C;;GAEG;AACH,MAAM,OAAO,uBAAwB,SAAQ,mBAAmB;IAC9D,YAAY,UAA0C,EAAE;QACtD,KAAK,CACH,gDAAgD,EAChD,WAAW,EACX,MAAM,CAAC,MAAM,CAAC,EAAE,EAAE,OAAO,CAAC,CAC3B,CAAC;IACJ,CAAC;IACD;;;;OAIG;IACO,IAAI;QACZ,MAAM,MAAM,GAAoC,IAAI,mCAAmC,CACrF,qBAAqB,EACrB,CAAC,mBAAmB,EAAE,QAAQ,CAAC,EAC/B,CAAC,aAAa,EAAE,EAAE;YAChB,IAAI,OAAO,aAAa,CAAC,eAAe,KAAK,UAAU,EAAE,CAAC;gBACxD,aAAa,CAAC,eAAe,CAAC,IAAI,yBAAyB,EAAE,CAAC,CAAC;YACjE,CAAC;YAED,OAAO,aAAa,CAAC;QACvB,CAAC,CACF,CAAC;QACF,qCAAqC;QACrC,MAAM,CAAC,iBAAiB,GAAG,IAAI,CAAC;QAChC,OAAO,MAAM,CAAC;IAChB,CAAC;CACF;AAED;;;;;;;;;;;;;;;;;;GAkBG;AACH,MAAM,UAAU,6BAA6B,CAC3C,UAA0C,EAAE;IAE5C,OAAO,IAAI,uBAAuB,CAAC,OAAO,CAAC,CAAC;AAC9C,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n Instrumentation,\n InstrumentationBase,\n InstrumentationConfig,\n InstrumentationModuleDefinition,\n InstrumentationNodeModuleDefinition,\n} from \"@opentelemetry/instrumentation\";\n\nimport { OpenTelemetryInstrumenter } from \"./instrumenter\";\nimport { SDK_VERSION } from \"./configuration\";\n\n/**\n * Configuration options that can be passed to {@link createAzureSdkInstrumentation} function.\n */\nexport interface AzureSdkInstrumentationOptions extends InstrumentationConfig {}\n\n/**\n * The instrumentation module for the Azure SDK. Implements OpenTelemetry's {@link Instrumentation}.\n */\nexport class AzureSdkInstrumentation extends InstrumentationBase {\n constructor(options: AzureSdkInstrumentationOptions = {}) {\n super(\n \"@azure/opentelemetry-instrumentation-azure-sdk\",\n SDK_VERSION,\n Object.assign({}, options),\n );\n }\n /**\n * Entrypoint for the module registration.\n *\n * @returns The patched \\@azure/core-tracing module after setting its instrumenter.\n */\n protected init(): void | InstrumentationModuleDefinition | InstrumentationModuleDefinition[] {\n const result: InstrumentationModuleDefinition = new InstrumentationNodeModuleDefinition(\n \"@azure/core-tracing\",\n [\"^1.0.0-preview.14\", \"^1.0.0\"],\n (moduleExports) => {\n if (typeof moduleExports.useInstrumenter === \"function\") {\n moduleExports.useInstrumenter(new OpenTelemetryInstrumenter());\n }\n\n return moduleExports;\n },\n );\n // Needed to support 1.0.0-preview.14\n result.includePrerelease = true;\n return result;\n }\n}\n\n/**\n * Enables Azure SDK Instrumentation using OpenTelemetry for Azure SDK client libraries.\n *\n * When registered, any Azure data plane package will begin emitting tracing spans for internal calls\n * as well as network calls\n *\n * Example usage:\n * ```ts\n * const openTelemetryInstrumentation = require(\"@opentelemetry/instrumentation\");\n * openTelemetryInstrumentation.registerInstrumentations({\n * instrumentations: [createAzureSdkInstrumentation()],\n * })\n * ```\n *\n * @remarks\n *\n * As OpenTelemetry instrumentations rely on patching required modules, you should register\n * this instrumentation as early as possible and before loading any Azure Client Libraries.\n */\nexport function createAzureSdkInstrumentation(\n options: AzureSdkInstrumentationOptions = {},\n): Instrumentation {\n return new AzureSdkInstrumentation(options);\n}\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"file":"instrumenter.js","sourceRoot":"","sources":["../../src/instrumenter.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EACL,oBAAoB,EAEpB,OAAO,EACP,oBAAoB,EACpB,oBAAoB,EACpB,KAAK,GACN,MAAM,oBAAoB,CAAC;AAO5B,OAAO,EAAE,yBAAyB,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEjF,OAAO,EAAE,wBAAwB,EAAE,MAAM,eAAe,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAClD,OAAO,EAAE,aAAa,EAAE,MAAM,mBAAmB,CAAC;AAElD,oGAAoG;AACpG,MAAM,CAAC,MAAM,UAAU,GAAG,IAAI,yBAAyB,EAAE,CAAC;AAE1D,MAAM,OAAO,yBAAyB;IACpC,SAAS,CACP,IAAY,EACZ,WAAoC;QAEpC,IAAI,GAAG,GAAG,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,cAAc,KAAI,OAAO,CAAC,MAAM,EAAE,CAAC;QAC1D,IAAI,IAAU,CAAC;QAEf,IAAI,eAAe,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC9C,sDAAsD;YACtD,IAAI,GAAG,KAAK,CAAC,eAAe,CAAC,oBAAoB,CAAC,CAAC;QACrD,CAAC;aAAM,CAAC;YACN,kBAAkB;YAClB,IAAI,GAAG,KAAK;iBACT,SAAS,CAAC,WAAW,CAAC,WAAW,EAAE,WAAW,CAAC,cAAc,CAAC;iBAC9D,SAAS,CAAC,IAAI,EAAE,aAAa,CAAC,WAAW,CAAC,EAAE,GAAG,CAAC,CAAC;YAEpD,IACE,eAAe,CAAC,sCAAsC,CAAC;gBACvD,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,MAAM,CAAC,EACrC,CAAC;gBACD,2BAA2B;gBAC3B,GAAG,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC;YAC7B,CAAC;QACH,CAAC;QAED,OAAO;YACL,IAAI,EAAE,IAAI,wBAAwB,CAAC,IAAI,CAAC;YACxC,cAAc,EAAE,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC;SACzC,CAAC;IACJ,CAAC;IACD,WAAW,CAIT,cAA8B,EAC9B,QAAkB,EAClB,GAAG,YAA0B;QAE7B,OAAO,OAAO,CAAC,IAAI,CACjB,cAAc,EACd,QAAQ;QACR,4DAA4D,CAAC,SAAS,EACtE,GAAG,YAAY,CAChB,CAAC;IACJ,CAAC;IAED,sBAAsB,CAAC,iBAAyB;QAC9C,OAAO,UAAU,CAAC,OAAO,CACvB,OAAO,CAAC,MAAM,EAAE,EAChB,EAAE,WAAW,EAAE,iBAAiB,EAAE,EAClC,oBAAoB,CACrB,CAAC;IACJ,CAAC;IAED,oBAAoB,CAAC,cAA+B;QAClD,MAAM,OAAO,GAA2B,EAAE,CAAC;QAC3C,UAAU,CAAC,MAAM,CAAC,cAAc,IAAI,OAAO,CAAC,MAAM,EAAE,EAAE,OAAO,EAAE,oBAAoB,CAAC,CAAC;QACrF,OAAO,OAAO,CAAC;IACjB,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport {\n INVALID_SPAN_CONTEXT,\n Span,\n context,\n defaultTextMapGetter,\n defaultTextMapSetter,\n trace,\n} from \"@opentelemetry/api\";\nimport {\n Instrumenter,\n InstrumenterSpanOptions,\n TracingContext,\n TracingSpan,\n} from \"@azure/core-tracing\";\nimport { W3CTraceContextPropagator, suppressTracing } from \"@opentelemetry/core\";\n\nimport { OpenTelemetrySpanWrapper } from \"./spanWrapper\";\nimport { envVarToBoolean } from \"./configuration\";\nimport { toSpanOptions } from \"./transformations\";\n\n// While default propagation is user-configurable, Azure services always use the W3C implementation.\nexport const propagator = new W3CTraceContextPropagator();\n\nexport class OpenTelemetryInstrumenter implements Instrumenter {\n startSpan(\n name: string,\n spanOptions: InstrumenterSpanOptions,\n ): { span: TracingSpan; tracingContext: TracingContext } {\n let ctx = spanOptions?.tracingContext || context.active();\n let span: Span;\n\n if (envVarToBoolean(\"AZURE_TRACING_DISABLED\")) {\n // disable only our spans but not any downstream spans\n span = trace.wrapSpanContext(INVALID_SPAN_CONTEXT);\n } else {\n // Create our span\n span = trace\n .getTracer(spanOptions.packageName, spanOptions.packageVersion)\n .startSpan(name, toSpanOptions(spanOptions), ctx);\n\n if (\n envVarToBoolean(\"AZURE_HTTP_TRACING_CHILDREN_DISABLED\") &&\n name.toUpperCase().startsWith(\"HTTP\")\n ) {\n // disable downstream spans\n ctx = suppressTracing(ctx);\n }\n }\n\n return {\n span: new OpenTelemetrySpanWrapper(span),\n tracingContext: trace.setSpan(ctx, span),\n };\n }\n withContext<\n CallbackArgs extends unknown[],\n Callback extends (...args: CallbackArgs) => ReturnType<Callback>,\n >(\n tracingContext: TracingContext,\n callback: Callback,\n ...callbackArgs: CallbackArgs\n ): ReturnType<Callback> {\n return context.with(\n tracingContext,\n callback,\n /** Assume caller will bind `this` or use arrow functions */ undefined,\n ...callbackArgs,\n );\n }\n\n parseTraceparentHeader(traceparentHeader: string): TracingContext {\n return propagator.extract(\n context.active(),\n { traceparent: traceparentHeader },\n defaultTextMapGetter,\n );\n }\n\n createRequestHeaders(tracingContext?: TracingContext): Record<string, string> {\n const headers: Record<string, string> = {};\n propagator.inject(tracingContext || context.active(), headers, defaultTextMapSetter);\n return headers;\n }\n}\n"]}
@@ -1,46 +0,0 @@
1
- // Copyright (c) Microsoft Corporation.
2
- // Licensed under the MIT license.
3
- import { SpanStatusCode } from "@opentelemetry/api";
4
- export class OpenTelemetrySpanWrapper {
5
- constructor(span) {
6
- this._span = span;
7
- }
8
- setStatus(status) {
9
- if (status.status === "error") {
10
- if (status.error) {
11
- this._span.setStatus({ code: SpanStatusCode.ERROR, message: status.error.toString() });
12
- this.recordException(status.error);
13
- }
14
- else {
15
- this._span.setStatus({ code: SpanStatusCode.ERROR });
16
- }
17
- }
18
- else if (status.status === "success") {
19
- this._span.setStatus({ code: SpanStatusCode.OK });
20
- }
21
- }
22
- setAttribute(name, value) {
23
- if (value !== null && value !== undefined) {
24
- this._span.setAttribute(name, value);
25
- }
26
- }
27
- end() {
28
- this._span.end();
29
- }
30
- recordException(exception) {
31
- this._span.recordException(exception);
32
- }
33
- isRecording() {
34
- return this._span.isRecording();
35
- }
36
- /**
37
- * Allows getting the wrapped span as needed.
38
- * @internal
39
- *
40
- * @returns The underlying span
41
- */
42
- unwrap() {
43
- return this._span;
44
- }
45
- }
46
- //# sourceMappingURL=spanWrapper.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"spanWrapper.js","sourceRoot":"","sources":["../../src/spanWrapper.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAElC,OAAO,EAAwB,cAAc,EAAE,MAAM,oBAAoB,CAAC;AAG1E,MAAM,OAAO,wBAAwB;IAGnC,YAAY,IAAU;QACpB,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,SAAS,CAAC,MAAkB;QAC1B,IAAI,MAAM,CAAC,MAAM,KAAK,OAAO,EAAE,CAAC;YAC9B,IAAI,MAAM,CAAC,KAAK,EAAE,CAAC;gBACjB,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,OAAO,EAAE,MAAM,CAAC,KAAK,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC;gBACvF,IAAI,CAAC,eAAe,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YACrC,CAAC;iBAAM,CAAC;gBACN,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,KAAK,EAAE,CAAC,CAAC;YACvD,CAAC;QACH,CAAC;aAAM,IAAI,MAAM,CAAC,MAAM,KAAK,SAAS,EAAE,CAAC;YACvC,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,EAAE,IAAI,EAAE,cAAc,CAAC,EAAE,EAAE,CAAC,CAAC;QACpD,CAAC;IACH,CAAC;IAED,YAAY,CAAC,IAAY,EAAE,KAAc;QACvC,IAAI,KAAK,KAAK,IAAI,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YAC1C,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,IAAI,EAAE,KAAuB,CAAC,CAAC;QACzD,CAAC;IACH,CAAC;IAED,GAAG;QACD,IAAI,CAAC,KAAK,CAAC,GAAG,EAAE,CAAC;IACnB,CAAC;IAED,eAAe,CAAC,SAAyB;QACvC,IAAI,CAAC,KAAK,CAAC,eAAe,CAAC,SAAS,CAAC,CAAC;IACxC,CAAC;IAED,WAAW;QACT,OAAO,IAAI,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;IAClC,CAAC;IAED;;;;;OAKG;IACH,MAAM;QACJ,OAAO,IAAI,CAAC,KAAK,CAAC;IACpB,CAAC;CACF","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { Span, AttributeValue, SpanStatusCode } from \"@opentelemetry/api\";\nimport { SpanStatus, TracingSpan } from \"@azure/core-tracing\";\n\nexport class OpenTelemetrySpanWrapper implements TracingSpan {\n private _span: Span;\n\n constructor(span: Span) {\n this._span = span;\n }\n\n setStatus(status: SpanStatus): void {\n if (status.status === \"error\") {\n if (status.error) {\n this._span.setStatus({ code: SpanStatusCode.ERROR, message: status.error.toString() });\n this.recordException(status.error);\n } else {\n this._span.setStatus({ code: SpanStatusCode.ERROR });\n }\n } else if (status.status === \"success\") {\n this._span.setStatus({ code: SpanStatusCode.OK });\n }\n }\n\n setAttribute(name: string, value: unknown): void {\n if (value !== null && value !== undefined) {\n this._span.setAttribute(name, value as AttributeValue);\n }\n }\n\n end(): void {\n this._span.end();\n }\n\n recordException(exception: string | Error): void {\n this._span.recordException(exception);\n }\n\n isRecording(): boolean {\n return this._span.isRecording();\n }\n\n /**\n * Allows getting the wrapped span as needed.\n * @internal\n *\n * @returns The underlying span\n */\n unwrap(): Span {\n return this._span;\n }\n}\n"]}
@@ -1 +0,0 @@
1
- {"version":3,"file":"transformations.js","sourceRoot":"","sources":["../../src/transformations.ts"],"names":[],"mappings":"AAAA,uCAAuC;AACvC,kCAAkC;AAGlC,OAAO,EAAoC,QAAQ,EAAe,KAAK,EAAE,MAAM,oBAAoB,CAAC;AAEpG;;;;;;GAMG;AACH,MAAM,UAAU,uBAAuB,CACrC,eAAmB;IAEnB,MAAM,GAAG,GAAG,CAAC,eAAe,IAAI,UAAU,CAAC,CAAC,WAAW,EAA2B,CAAC;IACnF,OAAO,QAAQ,CAAC,GAAG,CAAuB,CAAC;AAC7C,CAAC;AAaD;;;;;GAKG;AACH,SAAS,oBAAoB,CAAC,YAA+B,EAAE;IAC7D,OAAO,SAAS,CAAC,MAAM,CAAC,CAAC,GAAG,EAAE,eAAe,EAAE,EAAE;QAC/C,MAAM,WAAW,GAAG,KAAK,CAAC,cAAc,CAAC,eAAe,CAAC,cAAc,CAAC,CAAC;QACzE,IAAI,WAAW,EAAE,CAAC;YAChB,GAAG,CAAC,IAAI,CAAC;gBACP,OAAO,EAAE,WAAW;gBACpB,UAAU,EAAE,6BAA6B,CAAC,eAAe,CAAC,UAAU,CAAC;aACtE,CAAC,CAAC;QACL,CAAC;QACD,OAAO,GAAG,CAAC;IACb,CAAC,EAAE,EAAY,CAAC,CAAC;AACnB,CAAC;AAED;;;;;GAKG;AACH,SAAS,6BAA6B,CACpC,cAAsD;IAEtD,MAAM,UAAU,GAAqD,EAAE,CAAC;IACxE,KAAK,MAAM,GAAG,IAAI,cAAc,EAAE,CAAC;QACjC,oCAAoC;QACpC,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,IAAI,IAAI,cAAc,CAAC,GAAG,CAAC,KAAK,SAAS,EAAE,CAAC;YACtE,UAAU,CAAC,GAAG,CAAC,GAAG,cAAc,CAAC,GAAG,CAAmB,CAAC;QAC1D,CAAC;IACH,CAAC;IACD,OAAO,UAAU,CAAC;AACpB,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,WAAqC;IACjE,MAAM,EAAE,cAAc,EAAE,SAAS,EAAE,QAAQ,EAAE,GAAG,WAAW,IAAI,EAAE,CAAC;IAElE,MAAM,UAAU,GAAe,6BAA6B,CAAC,cAAc,CAAC,CAAC;IAC7E,MAAM,IAAI,GAAG,uBAAuB,CAAC,QAAQ,CAAC,CAAC;IAC/C,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAE9C,OAAO;QACL,UAAU;QACV,IAAI;QACJ,KAAK;KACN,CAAC;AACJ,CAAC","sourcesContent":["// Copyright (c) Microsoft Corporation.\n// Licensed under the MIT license.\n\nimport { InstrumenterSpanOptions, TracingSpanKind, TracingSpanLink } from \"@azure/core-tracing\";\nimport { Attributes, AttributeValue, Link, SpanKind, SpanOptions, trace } from \"@opentelemetry/api\";\n\n/**\n * Converts our TracingSpanKind to the corresponding OpenTelemetry SpanKind.\n *\n * By default it will return {@link SpanKind.INTERNAL}\n * @param tracingSpanKind - The core tracing {@link TracingSpanKind}\n * @returns - The OpenTelemetry {@link SpanKind}\n */\nexport function toOpenTelemetrySpanKind<K extends TracingSpanKind>(\n tracingSpanKind?: K,\n): SpanKindMapping[K] {\n const key = (tracingSpanKind || \"internal\").toUpperCase() as keyof typeof SpanKind;\n return SpanKind[key] as SpanKindMapping[K];\n}\n\n/**\n * A mapping between our {@link TracingSpanKind} union type and OpenTelemetry's {@link SpanKind}.\n */\ntype SpanKindMapping = {\n client: SpanKind.CLIENT;\n server: SpanKind.SERVER;\n producer: SpanKind.PRODUCER;\n consumer: SpanKind.CONSUMER;\n internal: SpanKind.INTERNAL;\n};\n\n/**\n * Converts core-tracing's TracingSpanLink to OpenTelemetry's Link\n *\n * @param spanLinks - The core tracing {@link TracingSpanLink} to convert\n * @returns A set of {@link Link}s\n */\nfunction toOpenTelemetryLinks(spanLinks: TracingSpanLink[] = []): Link[] {\n return spanLinks.reduce((acc, tracingSpanLink) => {\n const spanContext = trace.getSpanContext(tracingSpanLink.tracingContext);\n if (spanContext) {\n acc.push({\n context: spanContext,\n attributes: toOpenTelemetrySpanAttributes(tracingSpanLink.attributes),\n });\n }\n return acc;\n }, [] as Link[]);\n}\n\n/**\n * Converts core-tracing's span attributes to OpenTelemetry attributes.\n *\n * @param spanAttributes - The set of attributes to convert.\n * @returns An {@link SpanAttributes} to set on a span.\n */\nfunction toOpenTelemetrySpanAttributes(\n spanAttributes: { [key: string]: unknown } | undefined,\n): Attributes {\n const attributes: ReturnType<typeof toOpenTelemetrySpanAttributes> = {};\n for (const key in spanAttributes) {\n // Any non-nullish value is allowed.\n if (spanAttributes[key] !== null && spanAttributes[key] !== undefined) {\n attributes[key] = spanAttributes[key] as AttributeValue;\n }\n }\n return attributes;\n}\n\n/**\n * Converts core-tracing span options to OpenTelemetry options.\n *\n * @param spanOptions - The {@link InstrumenterSpanOptions} to convert.\n * @returns An OpenTelemetry {@link SpanOptions} that can be used when creating a span.\n */\nexport function toSpanOptions(spanOptions?: InstrumenterSpanOptions): SpanOptions {\n const { spanAttributes, spanLinks, spanKind } = spanOptions || {};\n\n const attributes: Attributes = toOpenTelemetrySpanAttributes(spanAttributes);\n const kind = toOpenTelemetrySpanKind(spanKind);\n const links = toOpenTelemetryLinks(spanLinks);\n\n return {\n attributes,\n kind,\n links,\n };\n}\n"]}