feat(sdk-node): configure trace exporter with environment variables #3143
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
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,118 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| import { diag } from '@opentelemetry/api'; | ||
| import { getEnv, getEnvWithoutDefaults } from '@opentelemetry/core'; | ||
| import { ConsoleSpanExporter, SpanExporter, BatchSpanProcessor, SimpleSpanProcessor, SDKRegistrationConfig, SpanProcessor } from '@opentelemetry/sdk-trace-base'; | ||
| import { NodeTracerConfig, NodeTracerProvider } from '@opentelemetry/sdk-trace-node'; | ||
| import { OTLPTraceExporter as OTLPProtoTraceExporter } from '@opentelemetry/exporter-trace-otlp-proto'; | ||
| import { OTLPTraceExporter as OTLPHttpTraceExporter} from '@opentelemetry/exporter-trace-otlp-http'; | ||
| import { OTLPTraceExporter as OTLPGrpcTraceExporter} from '@opentelemetry/exporter-trace-otlp-grpc'; | ||
| import { ZipkinExporter } from '@opentelemetry/exporter-zipkin'; | ||
| import { JaegerExporter } from '@opentelemetry/exporter-jaeger'; | ||
|
|
||
| export class TracerProviderWithEnvExporters extends NodeTracerProvider { | ||
svetlanabrennan marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| private _configuredExporters: SpanExporter[] = []; | ||
| private _spanProcessors: SpanProcessor[] | undefined; | ||
|
|
||
| static configureOtlp(): SpanExporter { | ||
| const protocol = this.getOtlpProtocol(); | ||
|
|
||
| switch (protocol) { | ||
| case 'grpc': | ||
| return new OTLPGrpcTraceExporter; | ||
| case 'http/json': | ||
| return new OTLPHttpTraceExporter; | ||
| case 'http/protobuf': | ||
| return new OTLPProtoTraceExporter; | ||
| default: | ||
| diag.warn(`Unsupported OTLP traces protocol: ${protocol}. Using http/protobuf.`); | ||
| return new OTLPProtoTraceExporter; | ||
| } | ||
| } | ||
|
|
||
| static getOtlpProtocol(): string { | ||
| const parsedEnvValues = getEnvWithoutDefaults(); | ||
|
|
||
| return parsedEnvValues.OTEL_EXPORTER_OTLP_TRACES_PROTOCOL ?? | ||
| parsedEnvValues.OTEL_EXPORTER_OTLP_PROTOCOL ?? | ||
| getEnv().OTEL_EXPORTER_OTLP_TRACES_PROTOCOL ?? | ||
| getEnv().OTEL_EXPORTER_OTLP_PROTOCOL; | ||
| } | ||
|
|
||
| protected static override _registeredExporters = new Map< | ||
| string, | ||
| () => SpanExporter | ||
| >([ | ||
| ['otlp', () => this.configureOtlp()], | ||
| ['zipkin', () => new ZipkinExporter], | ||
| ['jaeger', () => new JaegerExporter], | ||
| ['console', () => new ConsoleSpanExporter] | ||
| ]); | ||
|
|
||
| public constructor(config: NodeTracerConfig = {}) { | ||
| super(config); | ||
| let traceExportersList = this.filterBlanksAndNulls(Array.from(new Set(getEnv().OTEL_TRACES_EXPORTER.split(',')))); | ||
|
|
||
| if (traceExportersList.length === 0 || traceExportersList[0] === 'none') { | ||
| diag.warn('OTEL_TRACES_EXPORTER contains "none" or is empty. SDK will not be initialized.'); | ||
| } else { | ||
| if (traceExportersList.length > 1 && traceExportersList.includes('none')) { | ||
| diag.warn('OTEL_TRACES_EXPORTER contains "none" along with other exporters. Using default otlp exporter.'); | ||
| traceExportersList = ['otlp']; | ||
| } | ||
|
|
||
| traceExportersList.forEach(exporterName => { | ||
| const exporter = this._getSpanExporter(exporterName); | ||
| if (exporter) { | ||
| this._configuredExporters.push(exporter); | ||
| } else { | ||
| diag.warn(`Unrecognized OTEL_TRACES_EXPORTER value: ${exporterName}.`); | ||
| } | ||
| }); | ||
|
|
||
| if (this._configuredExporters.length > 0) { | ||
| this._spanProcessors = this.configureSpanProcessors(this._configuredExporters); | ||
| this._spanProcessors.forEach(processor => { | ||
| this.addSpanProcessor(processor); | ||
| }); | ||
| } else { | ||
| diag.warn('Unable to set up trace exporter(s) due to invalid exporter and/or protocol values.'); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| override register(config?: SDKRegistrationConfig) { | ||
| if (this._spanProcessors) { | ||
|
||
| super.register(config); | ||
| } | ||
| } | ||
|
|
||
| private configureSpanProcessors(exporters: SpanExporter[]): (BatchSpanProcessor | SimpleSpanProcessor)[] { | ||
| return exporters.map(exporter => { | ||
| if (exporter instanceof ConsoleSpanExporter) { | ||
| return new SimpleSpanProcessor(exporter); | ||
| } else { | ||
| return new BatchSpanProcessor(exporter); | ||
| } | ||
| }); | ||
| } | ||
|
|
||
| private filterBlanksAndNulls(list: string[]): string[] { | ||
| return list.map(item => item.trim()) | ||
| .filter(s => s !== 'null' && s !== ''); | ||
| } | ||
| } | ||
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.