0.66.0 • Published 1 week ago

@opentelemetry/instrumentation-restify

Licence

Apache-2.0

Version

0.66.0

Deps

Size

48 kB

Vulns

Weekly

Stars

917

Summary Dependency Versions

OpenTelemetry Restify Instrumentation for Node.js

This module provides automatic instrumentation for the restify module. It allows the user to automatically collect trace data and export them to their backend of choice.

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

Supported Versions

restify versions >=4.1.0 <12

Usage

const { NodeSDK } = require('@opentelemetry/sdk-node');
const { RestifyInstrumentation } = require('@opentelemetry/instrumentation-restify');

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

Restify Instrumentation Options

| Options | Type | Example | Description | | requestHook | RestifyCustomAttributeFunction | (span, requestInfo) => {} | Function for adding custom attributes to restify requests. Receives params: Span, RestifyRequestInfo. |

Using `requestHook`

Instrumentation configuration accepts a custom "hook" function which will be called for every instrumented restify request. Custom attributes can be set on the span or run any custom logic per request.

import { RestifyInstrumentation } from "@opentelemetry/instrumentation-restify"
const restifyInstrumentation = new RestifyInstrumentation({
  requestHook: function (span: Span, info: RestifyRequestInfo) {
    span.setAttribute(
      'http.method',
      info.request.method,
    )
  }
});

Semantic Conventions

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

Attributes collected:

Attribute	Short Description
`http.route`	The matched route (path template).

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