@saidsef/tracing-node
v3.0.1
Published
tracing NodeJS - This is a wrapper for OpenTelemetry instrumentation packages
Downloads
639
Maintainers
Readme
Opentelemetry Wrapper for Tracing Node Applications
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', 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 |
| service_name | string | service / application name |
| url | 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 :heart: you to contribute by making a pull request.
Please read the official Contribution Guide for more information on how you can contribute.