Logz.io nodejs metrics sdk

This topic includes instructions on how to send custom metrics to Logz.io from your Node.js application.

The included example uses the OpenTelemetry JS SDK and its based on OpenTelemetry exporter collector proto.

Before you begin, you'll need: Node 14 or higher

Note This project works best with logzio as metrics backend, but its compatible with all backends that support prometheuesrmotewrite format

Quick start

Install the package:

npm install logzio-nodejs-metrics-sdk@0.4.0
npm install @opentelemetry/sdk-metrics-base@0.27.0

Set the variables in the following code snippet:

Environment variable	Description
url	The Logz.io Listener URL for for your region, configured to use port 8052 for http traffic, or port 8053 for https traffic. For example - https://listener.logz.io:8053
token	Your Logz.io Prometheus Metrics account token.

1const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
2const sdk = require('logzio-nodejs-metrics-sdk');
3
4const collectorOptions = {
5    url: '<<url>>',
6    headers: {
7        Authorization: 'Bearer <<token>>',
8    },
9};
10// Initialize the exporter
11const metricExporter = new sdk.RemoteWriteExporter(collectorOptions);
12
13// Initialize the meter provider
14const meter = new MeterProvider({
15    readers: [
16        new PeriodicExportingMetricReader(
17            {
18                exporter: metricExporter, 
19                exportIntervalMillis: 1000
20            })
21        ],
22}).getMeter('example-exporter');
23
24// Create your first counter metric
25const requestCounter = meter.createCounter('Counter', {
26    description: 'Example of a Counter',
27});
28// Define some labels for your metrics
29const labels = { environment: 'prod' };
30// Record some value
31requestCounter.add(1, labels);
32// In logzio Metrics you will see the following metric:
33// Counter_total{environment: 'prod'} 1.0

Types of metric instruments

For more information, see the OpenTelemetry documentation.

Name	Behavior
Counter	Metric value can only go up or be reset to 0, calculated per counter.Add(context,value,labels) request.
UpDownCounter	Metric value can arbitrarily increment or decrement, calculated per updowncounter.Add(context,value,labels) request.
Histogram	Metric values captured by the histogram.Record(context,value,labels) function, calculated per request.

More examples

First Initialize the exporter and meter provider:

1const { MeterProvider, PeriodicExportingMetricReader } = require('@opentelemetry/sdk-metrics');
2const sdk = require('logzio-nodejs-metrics-sdk');
3
4const collectorOptions = {
5    url: '<<url>>',
6    headers: {
7        Authorization: 'Bearer <<token>>',
8    },
9};
10// Initialize the exporter
11const metricExporter = new sdk.RemoteWriteExporter(collectorOptions);
12
13// Initialize the meter provider
14const meter = new MeterProvider({
15    readers: [
16        new PeriodicExportingMetricReader(
17            {
18                exporter: metricExporter, 
19                exportIntervalMillis: 1000
20            })
21        ],
22}).getMeter('example-exporter');

Then create different types of metrics

UpDownCounter:

1// Create UpDownCounter metric
2const upDownCounter = meter.createUpDownCounter('UpDownCounter', {
3    description: 'Example of a UpDownCounter',
4});
5// Define some labels for your metrics
6const labels = { environment: 'prod' };
7// Record some values
8upDownCounter.add(5, labels);
9upDownCounter.add(-1, labels);
10// In logzio you will see the following metric:
11// UpDownCounter{environment: 'prod'} 4.0

Histogram:

1// Create ValueRecorder metric
2const histogram = meter.createHistogram('test_histogram', {
3    description: 'Example of a histogram',
4});
5// Define some labels for your metrics
6const labels = { environment: 'prod' };
7// Record some values
8histogram.record(30, labels);
9histogram.record(20), labels;
10// In logzio you will see the following metrics:
11// test_histogram_sum{environment: 'prod'} 50.0
12// test_histogram_count{environment: 'prod'} 2.0
13// test_histogram_avg{environment: 'prod'} 25.0

Update log

0.5.0

Breaking changes:

• Update dependencies versions
  • Upgrade to OTEL packages in version 1.26.0
• Update docs
• Drop support for Nodejs 12.*

0.4.0

Breaking changes:

• Drop support for Nodejs 8.* 10.*

Changelog:

• Fix bug which makes it crash if no metrics created/written before the first interval (@chapost1)
• Using axios instead of requestretry (@chapost1)

0.3.0

• Add github action for auto publish to npm
• Add option to update TimeUnixNano in metrics from Exporter

0.2.0

• Update otel dependencies and naming conventions
• Update docs
• Fix exporting modules names

0.1.0

• Initial Release