Opentelemetry initialization package for nodejs.
npm install @bpinternal/trail> Opentelemetry initialization package for nodejs
Trail is a utility to initialize the Opentelemetry library. First, you must install the instrumentation packages of the library you want to instrument.
For example, you could install the package @opentelemetry/instrumentation-express to instrument express. Then, your TypeScript program could look like this:
``ts
import { init } from '@bpinternal/trail'
init()
import express from 'express'
`
The available environment variables for configuring the tracing client are:
- TRACING_ENABLED bool Enables the tracerbool
- TRACING_DEBUG Adds debug information about the tracing configurationurl
- OTEL_EXPORTER_JAEGER_ENDPOINT Sets the Jaeger collector endpointstring
- OTEL_SERVICE_NAME Sets the service name given to a tracestring
- OTEL_SERVICE_VERSION Sets the current running version of the servicestring
- OTEL_SERVICE_VERSION_INSTANCE_ID Sets the node intance id on which the service is running onstring
- OTEL_SERVICE_NAMESPACE Sets the namespace of the servicestring
- OTEL_DEPLOYMENT_ENVIRONMENT Sets the environment of the service
This package is published under the @bpinternal` organization. All packages of this organization are meant to be used by the Botpress team internally and are not meant for our community. Since the packages are catered to our own use-cases, they might have less stable APIs, receive breaking changes without much warning, have minimal documentation and lack community-focused support. However, these packages were still left intentionally public for an important reason : We Love Open-Source. Therefore, if you wish to install or fork this package feel absolutly free to do it. We strongly recommend that you tag your versions properly.
The Botpress Engineering team.