@infineit/signoz-tracer
v1.0.17
Published
Enterprise-level opentelemetry integration package
Downloads
12
Maintainers
Readme
Introduction
@infineit/signoz-tracer
is a lightweight utility for integrating OpenTelemetry tracing with Signoz in a Node.js application. This package simplifies the setup of tracing and provides configurable options for instrumenting your application.
Features
- Easy Integration: Quickly integrate OpenTelemetry with Signoz for distributed tracing.
- Configurable: Provides options to customize tracer configuration.
- Lightweight: Minimal dependencies and overhead.
Installation
You can install this package using npm:
npm install @infineit/signoz-tracer
Or using Yarn:
yarn add @infineit/signoz-tracer
Usage
Basic Setup
To use @infineit/signoz-tracer
in your NestJS application, simply import it at the beginning of your main.ts
file:
import '@infineit/signoz-tracer';
Deploying SigNoz with Docker
Prerequisites
- NestJS
- SigNoz
Getting Started
Follow these steps to set up and run SigNoz using Docker. If all steps are followed correctly, SigNoz should start without any issues:
Clone the SigNoz repository:
git clone -b main https://github.com/SigNoz/signoz.git
Navigate to the deployment directory and run the installation script:
cd signoz/deploy/ ./install.sh
Start SigNoz with Docker Compose:
docker-compose up -d
Access the SigNoz dashboard locally:
http://localhost:3301
Reminder: Make sure SigNoz is running before starting your NestJS application to avoid initialization errors.
Configuration
You can configure the Signoz Tracer using environment variables in your .env
file:
OTLP_SERVICE_NAME
: The name of your service as it will appear in the SigNoz UI.OTLP_TRACE_URL
: The endpoint for your SigNoz collector.
Inspiration
This project is inspired by the excellent work from:
Support
NestJS is an MIT-licensed open-source project that thrives with support from the community. If you’d like to contribute or sponsor, please learn more here.
License
This project is licensed under the MIT License. See the LICENSE file for more details.
Author
Dharmesh Patel 🇮🇳