agentic-dev-template/instrumentation.md at 0a34b45bb707103df02a4f638622d17bd616c00d

Files

Danijel Martinek 14762d4ba0 docs(library-decisions): backfill socketRisk in 2026-05-14 traces

The Socket supply-chain filter (ADR-023) was added after the initial
library-trace backfill, leaving the 36 traces dated 2026-05-14 without
the socketRisk filter-results field the trace schema now expects.
Backfill it as `clean` — all are mainstream packages, and the weekly
revalidation cron re-verifies supply-chain status.

2026-05-20 17:02:13 +02:00

3.4 KiB

Raw Blame History

package, version, tier, decision, date, deciders, adr, filter-results, verification-commands, accepted-cves

package

version

tier

decision

date

deciders

adr

filter-results

verification-commands

accepted-cves

@opentelemetry/instrumentation

^0.55.0

core

approved

2026-05-14

Danijel Martinek

adr-017

license	types	maintenance	boundary-fit	shadow-check	eu-residency	cve-scan	named-consumer	socketRisk
Apache-2.0	native	active	pass	pass	n/a	clean	pass	clean

npm view @opentelemetry/instrumentation license

npm view @opentelemetry/instrumentation version

pnpm audit --audit-level=moderate

Filter: license

npm view @opentelemetry/instrumentation license returns Apache-2.0. Apache-2.0 is on the allowlist.

Filter: types

@opentelemetry/instrumentation is authored in TypeScript and ships its own .d.ts declaration files. No separate @types/ package is needed.

Filter: maintenance

Actively maintained by the OpenTelemetry community as the base package for auto-instrumentation plugins. The 0.55.x line is current and tracks the SDK release cycle.

Filter: boundary-fit

ADR-017 §11 enables auto-instrumentations (HTTP, undici, pg) in initOtelServerNode. @opentelemetry/instrumentation provides the base InstrumentationBase class and registration utilities required by all instrumentation plugins. It lives in core-shared/instrumentation/otel/ init paths only.

Filter: shadow-check

@opentelemetry/instrumentation is the standard OTel plugin infrastructure. No competing auto-instrumentation framework is present in the workspace.

Filter: eu-residency

@opentelemetry/instrumentation is a pure instrumentation framework with no network communication or data transmission. EU residency does not apply.

Filter: cve-scan

pnpm audit --audit-level=moderate reports no advisories against @opentelemetry/instrumentation at the time of this trace.

Filter: named-consumer

packages/core-shared/src/instrumentation/otel/init-otel-server-node.ts uses @opentelemetry/instrumentation to register the HTTP, undici, and pg instrumentation plugins (ADR-017 §11). These auto-instrumentations eliminate manual span creation for common I/O operations.

Prompt: replaces

Manual span wrapping around HTTP calls, database queries, and fetch operations. @opentelemetry/instrumentation enables the auto-instrumentation plugins that patch Node.js built-ins and popular libraries to emit spans automatically, replacing boilerplate tracer.startSpan() calls.

Prompt: migration-cost-out

Low. @opentelemetry/instrumentation is used only at SDK init time to register plugin instances. Removing it requires unregistering the auto-instrumentation plugins and optionally adding manual spans at call sites — a localized change in the init file.

Prompt: alternatives-considered

Manual span instrumentation only — No auto-instrumentation base package needed, but every HTTP call and DB query would require explicit span wrapping. Rejected: high boilerplate cost, easy to miss call sites.
DD-trace or other APM SDK — Vendor-specific auto-instrumentation agents. Rejected in ADR-017: vendor lock-in; OTel auto-instrumentations achieve the same coverage with vendor-neutral output.

See ADR-017 for the full decision rationale.

3.4 KiB Raw Blame History