@opentelemetry/instrumentation-memcached
TypeScript icon, indicating that this package has built-in type declarations

0.41.0 • Public • Published

OpenTelemetry Memcached Instrumentation for Node.js

NPM Published Version Apache License

This module provides automatic instrumentation for the memcached@>=2.2.0 module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle.

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-memcached

Supported Versions

Usage

OpenTelemetry Memcached Instrumentation allows the user to automatically collect trace data and export them to the backend of choice, to give observability to distributed systems when working with memcached.

To load a specific instrumentation (memcached in this case), specify it in the registerInstrumentations' configuration

const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { MemcachedInstrumentation } = require('@opentelemetry/instrumentation-memcached');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();
provider.register();

registerInstrumentations({
  instrumentations: [
    new MemcachedInstrumentation({
      enhancedDatabaseReporting: false,
    }),
  ],
});

Configuration Options

Option Type Example Description
enhancedDatabaseReporting boolean false Include full command statement in the span - leaks potentially sensitive information to your spans. Defaults to false.

Semantic Conventions

This package uses @opentelemetry/semantic-conventions version 1.22+, which implements Semantic Convention Version 1.7.0

Attributes collected:

Attribute Short Description
db.operation The name of the operation being executed.
db.statement The database statement being executed.
db.system An identifier for the database management system (DBMS) product being used.
net.peer.name Remote hostname or similar.
net.peer.port Remote port number.

Useful links

License

Apache 2.0 - See LICENSE for more information.

Package Sidebar

Install

npm i @opentelemetry/instrumentation-memcached

Weekly Downloads

747,002

Version

0.41.0

License

Apache-2.0

Unpacked Size

44.2 kB

Total Files

18

Last publish

Collaborators

  • pichlermarc
  • bogdandrutu
  • dyladan