0.65.0 • Published 1 month ago

@opentelemetry/instrumentation-lru-memoizer

Licence

Apache-2.0

Version

0.65.0

Deps

Size

23 kB

Vulns

Weekly

Stars

915

Summary Dependency Versions

OpenTelemetry lru-memoizer Instrumentation for Node.js

This module provides automatic instrumentation for the lru-memoizer module.

If total installation size is not constrained, it is recommended to use the @opentelemetry/auto-instrumentations-node bundle with @opentelemetry/sdk-node for the most seamless instrumentation experience.

Compatible with OpenTelemetry JS API and SDK 1.0+.

Installation

npm install --save @opentelemetry/instrumentation-lru-memoizer

Supported Versions

lru-memoizer versions >=1.3.0 <4

Usage

This instrumentation does not produce any telemetry data. It only bind the caller context to callbacks so downstream operations are recorded with the right context (traceId / parentSpanId / baggage / etc). The lru-memoizer package is a dependency for other packages such as jwks-rsa

To enable a specific instrumentation, pass it to registerInstrumentations(). This is commonly done via NodeSDK for fully setting up all OpenTelemetry SDK components:

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { LruMemoizerInstrumentation } = require('@opentelemetry/instrumentation-lru-memoizer');

const sdk = new NodeSDK({
  instrumentations: [
    new LruMemoizerInstrumentation(),
  ],
});
sdk.start();
process.once('beforeExit', async () => { await sdk.shutdown(); });

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