@opentelemetry/context-base

OpenTelemetry Base Context Manager

This package provides the ContextManager interface (which is used by concrete implementations) and a no-op implementation (which is used internally when no context propagation is defined). It's intended for use both on the server and in the browser.

What is a Context Manager

To understand why they exists, we'll need to understand how Javascript works: when you make native function call (networks, setInterval etc) you generally call C++ code that will later callback your own code.

A common issue when tracing a request in javascript is to link the function that have made the native call to the callback that the native code called when the response is there. Imagine you want to track for which user you made the request, you need some sort of "context/context aware storage".

ContextManager's aim to offer exactly that, it's API offer to store an object in the current context (with()) and if needed, bind() to a specific function call to find it back when the callback fire, which can later get retrieved using active().

This package only include the interface and a Noop implementation, for more information please see the async-hooks based ContextManager for NodeJS.

Useful links

• For more information on OpenTelemetry, visit: https://opentelemetry.io/
• For more about OpenTelemetry JavaScript: https://github.com/open-telemetry/opentelemetry-js
• For help or feedback on this project, join us in GitHub Discussions

License

Apache 2.0 - See LICENSE for more information.

Changelog

0.17.0

:boom: Breaking Change

• opentelemetry-api-metrics, opentelemetry-api, opentelemetry-core, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-node, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-sdk-node, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
  • #1925 feat(diag-logger): replace logger with diag logger (@MSNev)
• opentelemetry-api, opentelemetry-instrumentation-http, opentelemetry-node, opentelemetry-plugin-http, opentelemetry-tracing
  • #1899 chore: create NoopSpan instead reusing NOOP_SPAN (@Flarna)
• opentelemetry-tracing
  • #1908 chore: remove config from BasicTracerProvider#getTracer (@Flarna)
• opentelemetry-core, opentelemetry-instrumentation-http, opentelemetry-node, opentelemetry-plugin-http, opentelemetry-tracing
  • #1900 chore: remove NoRecordingSpan (@Flarna)
• opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-node, opentelemetry-sdk-node, opentelemetry-web
  • #1855 Use instrumentation loader to load plugins and instrumentations (@obecny)
• opentelemetry-api, opentelemetry-core, opentelemetry-shim-opentracing
  • #1876 refactor!: specification compliant baggage (@dyladan)
• opentelemetry-api-metrics, opentelemetry-api, opentelemetry-context-async-hooks, opentelemetry-context-base, opentelemetry-context-zone-peer-dep, opentelemetry-context-zone, opentelemetry-core, opentelemetry-exporter-collector-grpc, opentelemetry-exporter-collector-proto, opentelemetry-exporter-collector, opentelemetry-exporter-jaeger, opentelemetry-exporter-prometheus, opentelemetry-exporter-zipkin, opentelemetry-grpc-utils, opentelemetry-instrumentation-fetch, opentelemetry-instrumentation-grpc, opentelemetry-instrumentation-http, opentelemetry-instrumentation-xml-http-request, opentelemetry-instrumentation, opentelemetry-metrics, opentelemetry-node, opentelemetry-plugin-grpc-js, opentelemetry-plugin-grpc, opentelemetry-plugin-http, opentelemetry-plugin-https, opentelemetry-propagator-b3, opentelemetry-resource-detector-aws, opentelemetry-resource-detector-gcp, opentelemetry-resources, opentelemetry-sdk-node, opentelemetry-semantic-conventions, opentelemetry-shim-opentracing, opentelemetry-tracing, opentelemetry-web
  • #1874 More specific api type names (@dyladan)

:rocket: (Enhancement)

• opentelemetry-exporter-prometheus
  • #1857 feat: add prometheus exporter host and port env vars (@naseemkullah)
  • #1879 feat(prometheus): add getMetricsRequestHandler-method to Prometheus (@weyert)
• opentelemetry-core, opentelemetry-tracing
  • #1918 chore: batch processor, aligning with latest spec changes for environments variables (@obecny)
• opentelemetry-instrumentation-grpc
  • #1806 feat: merge grpc-js into grpc instrumentation #1657 (@vmarchaud)
• opentelemetry-api, opentelemetry-core
  • #1880 feat(diag-logger): introduce a new global level api.diag for internal diagnostic logging (@MSNev)
• Other
  • #1920 chore: adding compatibility matrix for core and contrib versions (@obecny)
• opentelemetry-api, opentelemetry-context-async-hooks, opentelemetry-context-base, opentelemetry-context-zone-peer-dep, opentelemetry-tracing, opentelemetry-web
  • #1883 feat: add support to forward args in context.with (@Flarna)
• opentelemetry-api, opentelemetry-core, opentelemetry-shim-opentracing
  • #1876 refactor!: specification compliant baggage (@dyladan)

:books: (Refine Doc)

• Other
  • #1904 chore: fix upgrade guideline (@dyladan)
• opentelemetry-api
  • #1901 doc: correct tracer docs (@Flarna)

Committers: 8

• Bartlomiej Obecny (@obecny)
• Daniel Dyla (@dyladan)
• Gerhard Stöbich (@Flarna)
• Naseem (@naseemkullah)
• Nev (@MSNev)
• Srikanth Chekuri (@lonewolf3739)
• Valentin Marchaud (@vmarchaud)
• Weyert de Boer (@weyert)