Skip to content

test(auto-instr-node): show result of setting both env vars #2325

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
blumamir merged 6 commits into from
Jul 23, 2024
Merged

test(auto-instr-node): show result of setting both env vars #2325

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
3f930c3
test(auto-instr-node): show result of setting both env vars
JamieDanielson Jul 11, 2024
e83c0ae
update to more reliable test and update docs
JamieDanielson Jul 17, 2024
6d70a21
remove unnecessary debug line
JamieDanielson Jul 18, 2024
4168a7e
Merge branch 'main' into jamie.add-test-for-enable-and-disable
blumamir Jul 22, 2024
a662a07
Merge branch 'main' into jamie.add-test-for-enable-and-disable
blumamir Jul 23, 2024
1f42b6d
Merge branch 'main' into jamie.add-test-for-enable-and-disable
blumamir Jul 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions metapackages/auto-instrumentations-node/src/utils.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,6 +149,12 @@ export function getNodeAutoInstrumentations(
const enabledInstrumentationsFromEnv = getEnabledInstrumentationsFromEnv();
const disabledInstrumentationsFromEnv = getDisabledInstrumentationsFromEnv();

if (enabledInstrumentationsFromEnv && disabledInstrumentationsFromEnv) {
diag.debug(
'OTEL_NODE_ENABLED_INSTRUMENTATIONS and OTEL_NODE_DISABLED_INSTRUMENTATIONS environment variables are mutually exclusive. All instrumentations are disabled.'
);
}

const instrumentations: Instrumentation[] = [];

for (const name of Object.keys(InstrumentationMap) as Array<
Expand Down
16 changes: 16 additions & 0 deletions metapackages/auto-instrumentations-node/test/utils.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,22 @@ describe('utils', () => {
}
});

it('will disable all instrumentations if both OTEL_NODE_ENABLED_INSTRUMENTATIONS and OTEL_NODE_DISABLED_INSTRUMENTATIONS are set', () => {
process.env.OTEL_NODE_DISABLED_INSTRUMENTATIONS = 'fs';
process.env.OTEL_NODE_ENABLED_INSTRUMENTATIONS = 'fs';
try {
const instrumentations = getNodeAutoInstrumentations();

assert.deepStrictEqual(
new Set(instrumentations.map(i => i.instrumentationName)),
new Set()
);
} finally {
delete process.env.OTEL_NODE_DISABLED_INSTRUMENTATIONS;
delete process.env.OTEL_NODE_ENABLED_INSTRUMENTATIONS;
}
});

it('should show error for none existing instrumentation', () => {
const spy = sinon.stub(diag, 'error');
const name = '@opentelemetry/instrumentation-http2';
Expand Down