@opentelemetry/plugin-react-load
v0.31.0
Published
OpenTelemetry instrumentation for React class component lifecycle methods
Downloads
480
Readme
OpenTelemetry Plugin React Load
This module provides automatic instrumentation for React lifecycles for Web applications, which may be loaded using the @opentelemetry/sdk-trace-web
package.
If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-web
bundle with @opentelemetry/sdk-trace-web
for the most seamless instrumentation experience.
Compatible with OpenTelemetry JS API and SDK 1.0+
.
Status
| Maturity | Component Owner | Compatibility | | ---------------------------------------- | -------------------------------------------------------- | --------------------- | | Unmaintained | N/A | API 1.0+SDK 1.0+ |
Installation
npm install --save @opentelemetry/plugin-react-load
Usage
import { BaseOpenTelemetryComponent } from '@opentelemetry/plugin-react-load';
// Set once for the entire plugin
BaseOpenTelemetryComponent.setLogger(logger);
BaseOpenTelemetryComponent.setTracer('name', 'version');
To instrument components, extend BaseOpenTelemetryComponent
:
import { BaseOpenTelemetryComponent } from '@opentelemetry/plugin-react-load';
export class Component1 extends BaseOpenTelemetryComponent { ... }
See /examples/react-load for a short example.
Semantic Conventions
This package does not currently generate any attributes from semantic conventions.
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.