chore(sdk-node): migrate to the new sdk-trace package #6828
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
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,39 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| /** | ||
| * Create SDK components from parsed declarative config. | ||
| * https://opentelemetry.io/docs/specs/otel/configuration/sdk/#create | ||
| */ | ||
|
|
||
| import type { | ||
| AttributeLimitsConfigModel, | ||
| SpanLimitsConfigModel, | ||
| } from '@opentelemetry/configuration'; | ||
| import type { SpanLimits } from '@opentelemetry/sdk-trace'; | ||
|
|
||
| export function createSpanLimitsFromConfig( | ||
| limits?: SpanLimitsConfigModel, | ||
| attribute_limits?: AttributeLimitsConfigModel | ||
| ): SpanLimits | undefined { | ||
| if (!limits && !attribute_limits) { | ||
| return undefined; | ||
| } | ||
| return { | ||
| attributeValueLengthLimit: | ||
| limits?.attribute_value_length_limit ?? | ||
| attribute_limits?.attribute_value_length_limit ?? | ||
| undefined, | ||
| attributeCountLimit: | ||
| limits?.attribute_count_limit ?? | ||
| attribute_limits?.attribute_count_limit ?? | ||
| undefined, | ||
| eventCountLimit: limits?.event_count_limit ?? undefined, | ||
| linkCountLimit: limits?.link_count_limit ?? undefined, | ||
| attributePerEventCountLimit: | ||
| limits?.event_attribute_count_limit ?? undefined, | ||
| attributePerLinkCountLimit: limits?.link_attribute_count_limit ?? undefined, | ||
| }; | ||
| } | ||
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,113 @@ | ||
| /* | ||
| * Copyright The OpenTelemetry Authors | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| */ | ||
|
|
||
| /** | ||
| * Create SDK components from environment variable settings. | ||
| * https://opentelemetry.io/docs/specs/otel/configuration/sdk-environment-variables/ | ||
| */ | ||
|
|
||
| import { diag } from '@opentelemetry/api'; | ||
| import { getNumberFromEnv, getStringFromEnv } from '@opentelemetry/core'; | ||
| import type { | ||
| Sampler, | ||
| SpanExporter, | ||
| SpanLimits, | ||
| } from '@opentelemetry/sdk-trace'; | ||
| import { BatchSpanProcessor } from '@opentelemetry/sdk-trace'; | ||
| import { | ||
| AlwaysOffSampler, | ||
| AlwaysOnSampler, | ||
| ParentBasedSampler, | ||
| TraceIdRatioBasedSampler, | ||
| } from '@opentelemetry/sdk-trace'; | ||
| import { getNonNegativeNumberFromEnv } from './utils'; | ||
|
|
||
| const DEFAULT_RATIO = 1; | ||
|
|
||
| export function createSamplerFromEnv(): Sampler | undefined { | ||
|
Contributor
Author
There was a problem hiding this comment. Note: Adapted from buildSamplerFromEnv in sdk-trace-base: |
||
| const samplerName = getStringFromEnv('OTEL_TRACES_SAMPLER'); | ||
| if (samplerName === undefined) { | ||
| return undefined; | ||
| } | ||
| switch (samplerName) { | ||
| case 'always_on': | ||
| return new AlwaysOnSampler(); | ||
| case 'always_off': | ||
| return new AlwaysOffSampler(); | ||
| case 'parentbased_always_on': | ||
| return new ParentBasedSampler({ | ||
| root: new AlwaysOnSampler(), | ||
| }); | ||
| case 'parentbased_always_off': | ||
| return new ParentBasedSampler({ | ||
| root: new AlwaysOffSampler(), | ||
| }); | ||
| case 'traceidratio': | ||
| return new TraceIdRatioBasedSampler(getSamplerRatioFromEnv()); | ||
| case 'parentbased_traceidratio': | ||
| return new ParentBasedSampler({ | ||
| root: new TraceIdRatioBasedSampler(getSamplerRatioFromEnv()), | ||
| }); | ||
| default: | ||
| diag.error( | ||
| `unknown OTEL_TRACES_SAMPLER value "${samplerName}", using default` | ||
| ); | ||
| return undefined; | ||
| } | ||
| } | ||
|
|
||
| function getSamplerRatioFromEnv(): number | undefined { | ||
| const ratio = getNumberFromEnv('OTEL_TRACES_SAMPLER_ARG'); | ||
| if (ratio == null) { | ||
| diag.error( | ||
| `OTEL_TRACES_SAMPLER_ARG is blank, defaulting to ${DEFAULT_RATIO}.` | ||
| ); | ||
| return DEFAULT_RATIO; | ||
| } | ||
|
|
||
| if (ratio < 0 || ratio > 1) { | ||
| diag.error( | ||
| `OTEL_TRACES_SAMPLER_ARG=${ratio} was given, but it is out of range ([0..1]), defaulting to ${DEFAULT_RATIO}.` | ||
| ); | ||
| return DEFAULT_RATIO; | ||
| } | ||
|
|
||
| return ratio; | ||
| } | ||
|
|
||
| export function createSpanLimitsFromEnv(): SpanLimits | undefined { | ||
|
Contributor
Author
There was a problem hiding this comment. Note: Adapted from |
||
| return { | ||
| attributeCountLimit: | ||
| getNumberFromEnv('OTEL_SPAN_ATTRIBUTE_COUNT_LIMIT') ?? | ||
| getNumberFromEnv('OTEL_ATTRIBUTE_COUNT_LIMIT'), | ||
| attributeValueLengthLimit: | ||
| getNumberFromEnv('OTEL_SPAN_ATTRIBUTE_VALUE_LENGTH_LIMIT') ?? | ||
| getNumberFromEnv('OTEL_ATTRIBUTE_VALUE_LENGTH_LIMIT'), | ||
| eventCountLimit: getNumberFromEnv('OTEL_SPAN_EVENT_COUNT_LIMIT'), | ||
| linkCountLimit: getNumberFromEnv('OTEL_SPAN_LINK_COUNT_LIMIT'), | ||
| attributePerEventCountLimit: getNumberFromEnv( | ||
| 'OTEL_SPAN_ATTRIBUTE_PER_EVENT_COUNT_LIMIT' | ||
| ), | ||
| attributePerLinkCountLimit: getNumberFromEnv( | ||
| 'OTEL_SPAN_ATTRIBUTE_PER_LINK_COUNT_LIMIT' | ||
| ), | ||
| }; | ||
| } | ||
|
|
||
| export function createBatchSpanProcessorFromEnv( | ||
| exporter: SpanExporter | ||
| ): BatchSpanProcessor { | ||
| return new BatchSpanProcessor({ | ||
| exporter, | ||
| maxQueueSize: getNonNegativeNumberFromEnv('OTEL_BSP_MAX_QUEUE_SIZE'), | ||
| scheduledDelayMillis: getNonNegativeNumberFromEnv( | ||
| 'OTEL_BSP_SCHEDULE_DELAY' | ||
| ), | ||
| exportTimeoutMillis: getNonNegativeNumberFromEnv('OTEL_BSP_EXPORT_TIMEOUT'), | ||
| maxExportBatchSize: getNonNegativeNumberFromEnv( | ||
| 'OTEL_BSP_MAX_EXPORT_BATCH_SIZE' | ||
| ), | ||
| }); | ||
| } | ||
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 |
|---|---|---|
|
|
@@ -14,8 +14,15 @@ export * as contextBase from '@opentelemetry/api'; | |
| export * as core from '@opentelemetry/core'; | ||
| export * as logs from '@opentelemetry/sdk-logs'; | ||
| export * as metrics from '@opentelemetry/sdk-metrics'; | ||
| export * as resources from '@opentelemetry/resources'; | ||
|
|
||
| /** | ||
| * @deprecated Import directly from `@opentelemetry/sdk-trace` instead. | ||
| */ | ||
| export * as node from '@opentelemetry/sdk-trace-node'; | ||
| /** | ||
| * @deprecated Import directly from `@opentelemetry/sdk-trace` instead. | ||
| */ | ||
| export * as tracing from '@opentelemetry/sdk-trace-base'; | ||
|
Comment on lines
+22
to
26
Contributor
Author
There was a problem hiding this comment. Note: These existing re-exports are the only reason sdk-node cannot yet drop its dep on sdk-trace-node and sdk-trace-base. We'll drop these with SDK 3.0.
Member
There was a problem hiding this comment. I see you opened #6824. If you're feeling adventurous, we could also try to remove it and see if anybody is unhappy with that. I'd be willing to bet that almost nobody is using these re-exports. We don't need to do it in this PR though, let's keep this low-friction for now. |
||
| /* eslint-enable no-restricted-syntax */ | ||
|
|
||
|
|
||
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.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Note: This continues the
create<SDK Thing>FromConfig()pattern started in #6785I've also started moving "FromConfig"-specific things to this file, from the overly large "utils.ts".
I think it'll be helpful for maint and testing to separate the "FromEnv" handling and the "FromConfig" handling. Over a number of PRs I'll move/re-implement things in utils.ts over to "create-from-config.ts" and "create-from-env.ts".