Nodejs OTEL Instrumentation

Overview

This Node.js application demonstrates the usage of OpenTelemetry to create and export metrics as observable gauges. It includes metrics for memory usage, concurrency, CPU usage, and run time, each associated with unique workflow and customer IDs. The OTEL Exporter is used to push metrics to a OTLP Endpoint which in this case is a vmagent which writes to Levitate.

You can checkout these links to know

• How to setup vmagent
• How to setup your Levitate cluster

Prerequisites

You need a vmagent running that the underlying OTEL Exporter can write to.

Features

• Memory Usage Gauge: Tracks the application's memory usage in megabytes.
• Concurrency Gauge: Monitors arbitrary concurrency levels within the application.
• CPU Usage Gauge: Measures CPU usage as a percentage.
• Run Time Gauge: Observes the run time in seconds.
• Workflow and Customer ID Attributes: Each metric includes attributes for workflow and customer IDs.

Installation

1. Clone the repository to your local machine.
2. Navigate to the application's directory.
3. Install the required dependencies:

npm install @opentelemetry/api@^1.3.0 \
            @opentelemetry/[email protected] \
            @opentelemetry/[email protected] \
            @opentelemetry/[email protected] \
            @opentelemetry/[email protected] \
            @opentelemetry/[email protected] \
            uuid@^9.0.1 \
            && npm install

Usage

Run the application using Node:

$ node app.js

Environment Variables

WORKFLOW_ID_COUNT

• Description: This variable represents the count of workflow IDs.
• Type: Integer
• Default Value: 1000

CUSTOMER_ID_COUNT

• Description: This variable represents the count of customer IDs.
• Type: Integer
• Default Value: 400

OTLP_ENDPOINT

• Description: The endpoint for OpenTelemetry Protocol (OTLP) for exporting telemetry data.
• Type: String
• Example Value: http://localhost:8429/opentelemetry/api/v1/push

SERVICE_NAME

• Description: The name of the service or application.
• Type: String
• Example Value: workflow-job

OTLP_METRIC_EXPORTER_FREQUENCY

• Description: The frequency (in milliseconds) for exporting OpenTelemetry metrics.
• Type: Integer
• Default Value: 15000 (15 seconds)

OTLP_METER_NAME

• Description: The name of the OpenTelemetry meter.
• Type: String
• Example Value: workflow-job-meter

ENVIRONMENT

• Description: The environment in which the application is running (e.g., "production," "development").
• Type: String
• Example Value: production

METRIC_PREFIX

• Description: A prefix name to add to the metrics exported.
• Type: String
• Example Value: my_app

Usage

These environment variables are used to configure various aspects of our application. Please ensure that they are correctly set according to the requirements of your environment. You can set them in your deployment scripts, environment configuration, or directly in your shell environment.

Default Values

Some of the variables have default values provided. These defaults are used if the corresponding environment variables are not explicitly set. You can override the defaults as needed for your specific deployment.

This will start the application and begin exporting metrics at a 15-second interval.

Note

In this example, we've demonstrated the initialization of a single meter with a fixed export frequency of 15 seconds. Within this meter, four separate gauges have been defined. If you find the need for variable export frequencies, you will need to specify and configure additional meters accordingly.

Configuration

• The application exports metrics to an OTLP compatible vmagent endpoint http://localhost:8429/opentelemetry/api/v1/push. Update this to point to your collector endpoint.
• The default export interval is set to 15 seconds. This can be adjusted in the PeriodicExportingMetricReader configuration.
• The application generates a set number of workflow and customer IDs, which can be modified as needed.

Observable Gauges

• Memory Usage: Captured using Node.js process.memoryUsage().
• Concurrency: A random value between 1 and 10.
• CPU Usage: Obtained from os.loadavg().
• Run Time: A random value between 0 and 60 seconds.

Each gauge is associated with unique workflow_id and customer_id attributes.

Here's the updated section of the README that reflects the changes for Docker and Docker Compose setup:

---

Docker and Docker Compose Setup

This application is configured to be run in a Docker container, making the setup and deployment process consistent and isolated across different environments.

Building with Docker

1. Build the Docker Image: Navigate to the directory containing the Dockerfile and run:

   docker build -t your-app-name .

   Replace your-app-name with the desired name for your Docker image.

2. Run the Docker Container: After building the image, start your application by running:

   docker run -p 3000:3000 your-app-name

Using Docker Compose

The application can also be run using Docker Compose, which simplifies the process of configuring and launching the container, especially when dealing with environment variables and port mappings.

1. Start the Application: Use Docker Compose to build and start the application:

   docker-compose up --build

2. Stop the Application: To stop and remove the containers, networks, and volumes created by up, use:

   docker-compose down

Configuration

• The docker-compose.yaml file contains environment variables that are crucial for the application's execution. These variables are set as per the application's requirements and should be modified if necessary.
• Ensure the OTLP endpoint (OTLP_ENDPOINT) is correctly set to point to your vmagent endpoint.

---

Note

This application is for demonstration purposes and may require adjustments for production use. Ensure the vmagent can handle the volume of data generated.