Integrate OpenTelemetry for Nest.js with infrastack.ai

What you will learn

How to set up your environment
How to your application using the infrastack.ai SDK or the official OpenTelemetry SDK

Prerequisites

An infrastack.ai account to get your API key
A Nest.js application

Follow the example project on GitHub

Getting started

Using the Infrastack SDK
Using the OpenTelemetry SDK

You can use the Infrastack SDK to instrument your Nest.js application with a single line of code.

Install the NPM package

npm install @infrastack/otel

yarn add @infrastack/otel

pnpm add @infrastack/otel

Prepare your environment

Export your API key as an environment variable.

export INFRASTACK_API_KEY=sk-1*************************f5af

Or you can set the environment variables in your .env file by using the dotenv library.

Create instrumentation.ts

Create an instrumentation.ts file under the src folder.

instrumentation.ts

import { Infrastack } from '@infrastack/otel';
Infrastack.init({
  serviceName: 'nestjs-otel-example',
});

If you don’t provide a service name, we will create a random name for you.

Import the instrumentation module in your main.ts file

main.ts

import './instrumentation';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(8081);
  console.log('Server is running on port 8081');
}
bootstrap();

Run your application

Run your Nest.js application with the default Nest.js command.

npm run start

After creating some traffic, you can check your data from the infrastack.ai dashboard.

You can use the OpenTelemetry Javascript SDK to instrument your Nest.js application.

Install the NPM packages

npm install --save @opentelemetry/sdk-node
npm install --save @opentelemetry/auto-instrumentations-node
npm install --save @opentelemetry/exporter-trace-otlp-grpc

yarn add @opentelemetry/sdk-node
yarn add @opentelemetry/auto-instrumentations-node
yarn add @opentelemetry/exporter-trace-otlp-grpc

pnpm add @opentelemetry/sdk-node
pnpm add @opentelemetry/auto-instrumentations-node
pnpm add @opentelemetry/exporter-trace-otlp-grpc

Prepare your environment

export OTEL_EXPORTER_OTLP_ENDPOINT="https://collector.infrastack.ai"
export OTEL_EXPORTER_OTLP_HEADERS="infrastack-api-key={{YOUR_INFRASTACK_API_KEY}}"

Or you can set the environment variables in your .env file by using the dotenv library.

Create instrumentation.ts

Here, you will create a file that will be used to instrument your application. You will have lower level control over the instrumentation process.

instrumentation.ts

import { NodeSDK } from '@opentelemetry/sdk-node';
import { getNodeAutoInstrumentations } from '@opentelemetry/auto-instrumentations-node';
import { OTLPTraceExporter } from '@opentelemetry/exporter-trace-otlp-grpc';
import { Resource } from '@opentelemetry/resources';
import { SemanticResourceAttributes } from '@opentelemetry/semantic-conventions';
import { CompressionAlgorithm } from '@opentelemetry/otlp-exporter-base';
import { ATTR_SERVICE_NAME, ATTR_SERVICE_VERSION } from '@opentelemetry/semantic-conventions';

// Exporter options with compression set to Gzip
const exporterOptions = {
  compression: CompressionAlgorithm.GZIP,
};

// Trace exporter initialization
const traceExporter = new OTLPTraceExporter(exporterOptions);

// SDK initialization with exporter, auto-instrumentation, and resource attributes
const sdk = new NodeSDK({
  traceExporter,
  instrumentations: [getNodeAutoInstrumentations()],
  resource: new Resource({
    [ATTR_SERVICE_NAME]: "{{YOUR_SERVICE_NAME}}",
    [ATTR_SERVICE_VERSION]: "{{YOUR_SERVICE_VERSION}}",
  }),
});

// Start the SDK and register it with the OpenTelemetry API
sdk.start();

// Graceful shutdown of SDK on process exit
process.on("SIGTERM", () => {
  sdk
    .shutdown()
    .then(() => console.log("Tracing terminated"))
    .catch((error) => console.log("Error terminating tracing", error))
    .finally(() => process.exit(0));
});

Import the instrumentation module in your main.ts file

main.ts

import './instrumentation';
import { NestFactory } from '@nestjs/core';
import { AppModule } from './app.module';

async function bootstrap() {
  const app = await NestFactory.create(AppModule);
  await app.listen(8081);
  console.log('Server is running on port 8081');
}
bootstrap();

Run your application

Run your Nest.js application with the default Nest.js command.

npm run start

After creating some traffic, you can check your data from the infrastack.ai dashboard.

Documentation

Guides

SDK Reference

Integrate OpenTelemetry for Nest.js with infrastack.ai

What you will learn

Prerequisites

Follow the example project on GitHub

Getting started

Next steps

Javascript SDK Reference

Explore the Nest.js example project

​What you will learn

​Prerequisites

Follow the example project on GitHub

​Getting started

​Next steps

Javascript SDK Reference

Explore the Nest.js example project

What you will learn

Prerequisites

Getting started

Next steps