mw-instrumentation-fetch
v0.36.0
Published
OpenTelemetry fetch automatic instrumentation package.
Downloads
3
Maintainers
Readme
OpenTelemetry Fetch Instrumentation for web
Note: This is an experimental package under active development. New releases may include breaking changes.
This module provides auto instrumentation for web using fetch.
Installation
npm install --save @opentelemetry/instrumentation-fetch
Usage
import {
ConsoleSpanExporter,
SimpleSpanProcessor,
WebTracerProvider,
} from '@opentelemetry/sdk-trace-web';
import { FetchInstrumentation } from '@opentelemetry/instrumentation-fetch';
import { ZoneContextManager } from '@opentelemetry/context-zone';
import { registerInstrumentations } from '@opentelemetry/instrumentation';
const provider = new WebTracerProvider();
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register({
contextManager: new ZoneContextManager(),
});
registerInstrumentations({
instrumentations: [new FetchInstrumentation()],
});
// or plugin can be also initialised separately and then set the tracer provider or meter provider
const fetchInstrumentation = new FetchInstrumentation();
const provider = new WebTracerProvider();
provider.register({
contextManager: new ZoneContextManager(),
});
fetchInstrumentation.setTracerProvider(provider);
provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
// and some test
fetch('http://localhost:8090/fetch.js');
Example Screenshots
See examples/tracer-web/fetch for a short example.
Fetch Instrumentation options
Fetch instrumentation plugin has few options available to choose from. You can set the following:
| Options | Type | Description |
|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|-------------------------------|-----------------------------------------------------------------------------------------|
| applyCustomAttributesOnSpan
| HttpCustomAttributeFunction
| Function for adding custom attributes |
| ignoreNetworkEvents
| boolean
| Disable network events being added as span events (network events are added by default) |
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.