Skip to content

Commit

Permalink
fixup! feat(sdk-trace-base)!: drop ability to instantiate propagators…
Browse files Browse the repository at this point in the history
… beyond defaults
  • Loading branch information
pichlermarc committed Jan 30, 2025
1 parent 78aca13 commit 6a4a5af
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions experimental/packages/opentelemetry-sdk-node/src/sdk.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ import {
getResourceDetectorsFromEnv,
getSpanProcessorsFromEnv,
filterBlanksAndNulls,
getPropgagatorFromEnv,
getPropagatorFromEnv,
} from './utils';

/** This class represents everything needed to register a fully configured OpenTelemetry Node.js SDK */
Expand Down Expand Up @@ -379,7 +379,7 @@ export class NodeSDK {
this._configuration?.contextManager,
propagator:
this._tracerProviderConfig?.textMapPropagator ??
getPropgagatorFromEnv(),
getPropagatorFromEnv(),
});
}

Expand Down
2 changes: 1 addition & 1 deletion experimental/packages/opentelemetry-sdk-node/src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ export function getSpanProcessorsFromEnv(): SpanProcessor[] {
/**
* Get a propagator as defined by environment variables
*/
export function getPropgagatorFromEnv(): TextMapPropagator | null | undefined {
export function getPropagatorFromEnv(): TextMapPropagator | null | undefined {
// Empty and undefined MUST be treated equal.
if (
process.env.OTEL_PROPAGATORS === undefined ||
Expand Down
16 changes: 8 additions & 8 deletions experimental/packages/opentelemetry-sdk-node/test/utils.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
* limitations under the License.
*/

import { getPropgagatorFromEnv } from '../src/utils';
import { getPropagatorFromEnv } from '../src/utils';
import * as assert from 'assert';
import * as sinon from 'sinon';
import { diag } from '@opentelemetry/api';
Expand All @@ -29,39 +29,39 @@ describe('getPropagatorFromEnv', function () {
it('when not defined', function () {
delete process.env.OTEL_PROPAGATORS;

const propagator = getPropgagatorFromEnv();
const propagator = getPropagatorFromEnv();

assert.deepStrictEqual(propagator, undefined);
});

it('on empty string', function () {
(process.env as any).OTEL_PROPAGATORS = '';

const propagator = getPropgagatorFromEnv();
const propagator = getPropagatorFromEnv();

assert.deepStrictEqual(propagator, undefined);
});

it('on space-only string', function () {
(process.env as any).OTEL_PROPAGATORS = ' ';

const propagator = getPropgagatorFromEnv();
const propagator = getPropagatorFromEnv();

assert.deepStrictEqual(propagator, undefined);
});
});

it('should return the selected propagator when one is in the list', () => {
process.env.OTEL_PROPAGATORS = 'tracecontext';
assert.deepStrictEqual(getPropgagatorFromEnv()?.fields(), [
assert.deepStrictEqual(getPropagatorFromEnv()?.fields(), [
'traceparent',
'tracestate',
]);
});

it('should return the selected propagators when multiple are in the list', () => {
process.env.OTEL_PROPAGATORS = 'tracecontext,baggage,b3,b3multi,jaeger';
assert.deepStrictEqual(getPropgagatorFromEnv()?.fields(), [
assert.deepStrictEqual(getPropagatorFromEnv()?.fields(), [
'traceparent',
'tracestate',
'b3',
Expand All @@ -78,7 +78,7 @@ describe('getPropagatorFromEnv', function () {
const warnStub = sinon.stub(diag, 'warn');

process.env.OTEL_PROPAGATORS = 'my, unknown, propagators';
assert.deepStrictEqual(getPropgagatorFromEnv(), null);
assert.deepStrictEqual(getPropagatorFromEnv(), null);
sinon.assert.calledWithExactly(
warnStub,
'Propagator "my" requested through environment variable is unavailable.'
Expand All @@ -97,6 +97,6 @@ describe('getPropagatorFromEnv', function () {
it('should return null if only "none" is selected', () => {
process.env.OTEL_PROPAGATORS = 'none';

assert.deepStrictEqual(getPropgagatorFromEnv(), null);
assert.deepStrictEqual(getPropagatorFromEnv(), null);
});
});

0 comments on commit 6a4a5af

Please sign in to comment.