Skip to content

saidsef/tracing-node

 
 

Repository files navigation

Opentelemetry Wrapper for Tracing Node Applications

CI Release GitHub issues npm npm

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
NODE_ENV
HOSTNAME
SERVICE_NAME
NAME_SPACE
SERVICE_VERSION
ENDPOINT

Function args

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

Required Parameters are

Name Type Description
hostname string container / pod hostname
service_name string service / application name
endpoint string tracing endpoint i.e. <schema>://<host>:<port>

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.