Skip to content

Opentelemetry based instrumentation for hyper-express which works on datadog backend, elastic APM etc

License

Notifications You must be signed in to change notification settings

tech-pw/opentelemetry-instrumentation-hyper-express

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenTelemetry Hyper-Express Instrumentation for Node.js

[![NPM Published Version][npm-img]][npm-url] [![Apache License][license-image]][license-image]

This module provides automatic instrumentation for the hyper-express module, which may be loaded using the @opentelemetry/sdk-trace-node package and is included in the @opentelemetry/auto-instrumentations-node bundle. 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 @pw-tech/instrumentation-hyper-express

Supported Versions

  • >=6.0.0

Usage

With opentelemetry

const { HyperExpressInstrumentation } = require('@pw-tech/instrumentation-hyper-express');
const { ConsoleSpanExporter, SimpleSpanProcessor } = require('@opentelemetry/sdk-trace-base');
const { NodeTracerProvider } = require('@opentelemetry/sdk-trace-node');
const { registerInstrumentations } = require('@opentelemetry/instrumentation');

const provider = new NodeTracerProvider();

provider.addSpanProcessor(new SimpleSpanProcessor(new ConsoleSpanExporter()));
provider.register();

registerInstrumentations({
  instrumentations: [
    new HyperExpressInstrumentation()
  ],
});

With Datadog (dd-trace)

let service = "your-service";

const tracer = require('dd-trace').init({
  service,
})
const { TracerProvider } = tracer;
const provider = new TracerProvider();
provider.register();

import HyperExpressInstrumentation from "@pw-tech/instrumentation-hyper-express";
const {
  getNodeAutoInstrumentations
} = require('@opentelemetry/auto-instrumentations-node');

new HyperExpressInstrumentation();

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

License

Apache 2.0 - See [LICENSE][license-url] for more information.

About

Opentelemetry based instrumentation for hyper-express which works on datadog backend, elastic APM etc

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published