Skip to content

Node.js wrapper for OpenTelemetry, enabling fast and easy distributed tracing setup. It auto-configures common instrumentations (HTTP, Express, AWS SDK, etc.) and provides a single entry point for integrating tracing

License

Notifications You must be signed in to change notification settings

saidsef/tracing-node

Opentelemetry Wrapper for Tracing Node Applications

CI Release GitHub issues npm npm GitHub release(latest by date) Commits

Get telemetry for your app in less than 3 minutes!

A wrapper around opentelemetry and set of instrumentation applications. This is to make instrumentation (more) idempotent.

Prerequisites

  • NodeJS
  • ...
  • Profit!

Instalation

npm install @saidsef/tracing-node --save

Usage

You can set required params via env variables or function:

Env vars:

CONTAINER_NAME || HOSTNAME
ENDPOINT
SERVICE_NAME

Function args

const { setupTracing } = require('@saidsef/tracing-node');
setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'});
import { setupTracing } from '@saidsef/tracing-node';
setupTracing({hostname: 'hostname', serviceName: 'service_name', url: 'endpoint'});

Required Parameters are

Name Type Description
hostname string container / pod hostname
serviceName string service / application name
url string tracing endpoint i.e. <schema>://<host>:<port>
enableFsInstrumentation boolean enable FS instrumentation, default false
enableDnsInstrumentation boolean enable DNS instrumentation, default false

Source

Our latest and greatest source of tracing-node can be found on GitHub. Fork us!

Contributing

We would ❤️ you to contribute by making a pull request.

Please read the official Contribution Guide for more information on how you can contribute.

About

Node.js wrapper for OpenTelemetry, enabling fast and easy distributed tracing setup. It auto-configures common instrumentations (HTTP, Express, AWS SDK, etc.) and provides a single entry point for integrating tracing

Topics

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Sponsor this project

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •