feat: add span metrics processor #849
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,136 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| // This replicates the sdk-node logic of getting processors from env, because | ||
| // the created NodeSDK doesn't expose the created processors and EDOT Node.js | ||
| // wants to customize the default. | ||
|
|
||
| const {getStringListFromEnv, getStringFromEnv} = require('@opentelemetry/core'); | ||
| const { | ||
| BatchSpanProcessor, | ||
| SimpleSpanProcessor, | ||
| ConsoleSpanExporter, | ||
| } = require('@opentelemetry/sdk-trace-base'); | ||
| const {log} = require('./logging'); | ||
|
|
||
| /** | ||
| * @typedef {import('@opentelemetry/sdk-trace-base').SpanProcessor} SpanProcessor | ||
| * @typedef {import('@opentelemetry/sdk-trace-base').SpanExporter} SpanExporter | ||
| */ | ||
|
|
||
| const otlpPkgPrefix = '@opentelemetry/exporter-trace-otlp-'; | ||
| const otlpProtocol = | ||
| getStringFromEnv('OTEL_EXPORTER_OTLP_TRACES_PROTOCOL') ?? | ||
| getStringFromEnv('OTEL_EXPORTER_OTLP_PROTOCOL') ?? | ||
| 'http/protobuf'; | ||
|
|
||
| // Jaeger exporter is deprecated but upstream stills support it (for now) | ||
| // ref: https://github.com/open-telemetry/opentelemetry-js/blob/main/experimental/CHANGELOG.md#0440 | ||
| function getJaegerExporter() { | ||
| // The JaegerExporter does not support being required in bundled | ||
| // environments. By delaying the require statement to here, we only crash when | ||
| // the exporter is actually used in such an environment. | ||
| try { | ||
| // @ts-ignore | ||
| const {JaegerExporter} = require('@opentelemetry/exporter-jaeger'); | ||
| return new JaegerExporter(); | ||
| } catch (e) { | ||
| throw new Error( | ||
| `Could not instantiate JaegerExporter. This could be due to the JaegerExporter's lack of support for bundling. If possible, use @opentelemetry/exporter-trace-otlp-proto instead. Original Error: ${e}` | ||
| ); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * @param {'otlp' | 'zipkin' | 'jaeger' | 'console'} type | ||
| * @returns {SpanExporter} | ||
| */ | ||
| function getSpanExporter(type) { | ||
| if (type === 'zipkin') { | ||
| const {ZipkinExporter} = require('@opentelemetry/exporter-zipkin'); | ||
| return new ZipkinExporter(); | ||
| } else if (type === 'jaeger') { | ||
| return getJaegerExporter(); | ||
| } else if (type === 'console') { | ||
| return new ConsoleSpanExporter(); | ||
| } | ||
|
|
||
| let exporterPkgName = `${otlpPkgPrefix}`; | ||
| switch (otlpProtocol) { | ||
| case 'grpc': | ||
| exporterPkgName += 'grpc'; | ||
| break; | ||
| case 'http/json': | ||
| exporterPkgName += 'http'; | ||
| break; | ||
| case 'http/protobuf': | ||
| exporterPkgName += 'proto'; | ||
| break; | ||
| default: | ||
| log.warn( | ||
| `Unsupported OTLP traces protocol: ${otlpProtocol}. Using http/protobuf.` | ||
| ); | ||
| exporterPkgName += 'proto'; | ||
| } | ||
| const {OTLPTraceExporter} = require(exporterPkgName); | ||
| return new OTLPTraceExporter(); | ||
| } | ||
|
|
||
| /** | ||
| * @returns {SpanProcessor[]} | ||
| */ | ||
| function getSpanProcessors() { | ||
| // Get from env | ||
| const exporters = getStringListFromEnv('OTEL_TRACES_EXPORTER') ?? []; | ||
| const result = []; | ||
|
|
||
| if (exporters[0] === 'none') { | ||
| log.warn( | ||
| 'OTEL_TRACES_EXPORTER contains "none". No trace information or Spans will be exported.' | ||
| ); | ||
| return []; | ||
| } | ||
|
|
||
| if (exporters.length === 0) { | ||
| log.trace( | ||
| 'OTEL_TRACES_EXPORTER is empty. Using the default "otlp" exporter.' | ||
| ); | ||
| exporters.push('otlp'); | ||
| } else if (exporters.length > 1 && exporters.includes('none')) { | ||
| log.warn( | ||
| 'OTEL_TRACES_EXPORTER contains "none" along with other exporters. Using default otlp exporter.' | ||
| ); | ||
| exporters.length = 0; | ||
| exporters.push('otlp'); | ||
| } | ||
|
|
||
| for (const name of exporters) { | ||
| log.trace(`Initializing "${name}" traces exporter.`); | ||
| switch (name) { | ||
| case 'otlp': | ||
| result.push(new BatchSpanProcessor(getSpanExporter('otlp'))); | ||
| break; | ||
| case 'console': | ||
| result.push( | ||
| new SimpleSpanProcessor(getSpanExporter('console')) | ||
| ); | ||
| break; | ||
| case 'zipkin': | ||
| result.push(new BatchSpanProcessor(getSpanExporter('zipkin'))); | ||
| break; | ||
| case 'jaeger': | ||
| result.push(new BatchSpanProcessor(getJaegerExporter())); | ||
| break; | ||
| default: | ||
| log.warn(`Unrecognized OTEL_TRACES_EXPORTER value: ${name}.`); | ||
| } | ||
| } | ||
|
|
||
| return result; | ||
| } | ||
|
|
||
| module.exports = { | ||
| getSpanProcessors, | ||
| }; | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,130 @@ | ||
| /* | ||
| * Copyright Elasticsearch B.V. and contributors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| // Gets the SDK configuration and updates it to have instruments | ||
| // to collect metrics related to the SDK, for now: | ||
| // - otel.sdk.span.live | ||
| // - otel.sdk.span.ended | ||
|
|
||
| const {metrics, TraceFlags} = require('@opentelemetry/api'); | ||
| const { | ||
| METRIC_OTEL_SDK_SPAN_ENDED, | ||
| METRIC_OTEL_SDK_SPAN_LIVE, | ||
| ATTR_OTEL_SPAN_SAMPLING_RESULT, | ||
| OTEL_SPAN_SAMPLING_RESULT_VALUE_RECORD_AND_SAMPLE, | ||
| OTEL_SPAN_SAMPLING_RESULT_VALUE_RECORD_ONLY, | ||
| } = require('./semconv'); | ||
|
|
||
| /** | ||
| * @typedef {import('@opentelemetry/api').Meter} Meter | ||
| * @typedef {import('@opentelemetry/api').UpDownCounter} UpDownCounter | ||
| * @typedef {import('@opentelemetry/api').Counter} Counter | ||
| * @typedef {import('@opentelemetry/sdk-trace-base').Span} Span | ||
| * @typedef {import('@opentelemetry/sdk-trace-base').ReadableSpan} ReadableSpan | ||
| * @typedef {import('@opentelemetry/sdk-trace-base').SpanProcessor} SpanProcessor | ||
| */ | ||
|
|
||
| // @ts-ignore - compiler options do not allow lookp outside `lib` folder | ||
| const ELASTIC_PKG = require('../package.json'); | ||
| const ELASTIC_SDK_VERSION = ELASTIC_PKG.version; | ||
| const ELASTIC_SDK_SCOPE = ELASTIC_PKG.name; | ||
|
|
||
| // NOTE: assuming the meter provider is not going to be replaced once | ||
| // the EDOT is started we can cache the meter and metrics in these vars | ||
| /** @type {Meter} */ | ||
| let selfMetricsMeter; | ||
| /** @type {UpDownCounter} */ | ||
| let liveSpans; | ||
| /** @type {Counter} */ | ||
| let closedSpans; | ||
|
|
||
| /** | ||
| * @returns {Meter} | ||
| */ | ||
| function getSpansMeter() { | ||
| if (selfMetricsMeter) { | ||
| return selfMetricsMeter; | ||
| } | ||
| // NOTE: we have a meter for a single scope which is the EDOT package | ||
| selfMetricsMeter = metrics.getMeter(ELASTIC_SDK_SCOPE, ELASTIC_SDK_VERSION); | ||
| return selfMetricsMeter; | ||
| } | ||
|
|
||
| /** | ||
| * @returns {UpDownCounter} | ||
| */ | ||
| function getLiveSpansCounter() { | ||
| if (liveSpans) { | ||
| return liveSpans; | ||
| } | ||
| liveSpans = getSpansMeter().createUpDownCounter(METRIC_OTEL_SDK_SPAN_LIVE, { | ||
| description: | ||
| 'Number of created spans for which the end operation has not been called yet', | ||
| }); | ||
| return liveSpans; | ||
| } | ||
|
|
||
| /** | ||
| * @returns {Counter} | ||
| */ | ||
| function getEndedSpansCounter() { | ||
| if (closedSpans) { | ||
| return closedSpans; | ||
| } | ||
| closedSpans = getSpansMeter().createCounter(METRIC_OTEL_SDK_SPAN_ENDED, { | ||
| description: | ||
| 'Number of created spans for which the end operation was called', | ||
| }); | ||
| return closedSpans; | ||
| } | ||
|
|
||
| /** | ||
| * All Spans treated in SpanProcessors are recording so here none will have | ||
| * a "DROP" sampling result | ||
| * @param {Span | ReadableSpan} span | ||
| * @returns {string} | ||
| */ | ||
| function getSamplingResult(span) { | ||
| const isSampled = span.spanContext().traceFlags & TraceFlags.SAMPLED; | ||
| return isSampled | ||
| ? OTEL_SPAN_SAMPLING_RESULT_VALUE_RECORD_AND_SAMPLE | ||
| : OTEL_SPAN_SAMPLING_RESULT_VALUE_RECORD_ONLY; | ||
| } | ||
|
|
||
| /** @type {SpanProcessor} */ | ||
| const spanMetricsProcessor = { | ||
| forceFlush: function () { | ||
| return Promise.resolve(); | ||
| }, | ||
| onStart: function (span) { | ||
| getLiveSpansCounter().add(1, { | ||
| [ATTR_OTEL_SPAN_SAMPLING_RESULT]: getSamplingResult(span), | ||
| }); | ||
| }, | ||
| onEnd: function (span) { | ||
| const attrs = { | ||
| [ATTR_OTEL_SPAN_SAMPLING_RESULT]: getSamplingResult(span), | ||
| }; | ||
| getLiveSpansCounter().add(-1, attrs); | ||
| getEndedSpansCounter().add(1, attrs); | ||
| }, | ||
| shutdown: function () { | ||
| return Promise.resolve(); | ||
| }, | ||
| }; | ||
|
|
||
| /** | ||
| * Updates the configuration to add OTEL SDK metrics | ||
| * ref: https://github.com/open-telemetry/semantic-conventions/blob/main/model/otel/metrics.yaml | ||
| * @param {Partial<import('@opentelemetry/sdk-node').NodeSDKConfiguration>} cfg | ||
| * @returns | ||
| */ | ||
| function setupSdkMetrics(cfg) { | ||
| cfg.spanProcessors.push(spanMetricsProcessor); | ||
| } | ||
|
|
||
| module.exports = { | ||
| setupSdkMetrics, | ||
| }; |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.