https://github.com/nioc/node-red-contrib-opentelemetry

Node-red node for distributed tracing with OpenTelemetry SDK
https://github.com/nioc/node-red-contrib-opentelemetry

node-red node-red-contrib opentelemetry otel prometheus-exporter

Last synced: about 1 month ago
JSON representation

Node-red node for distributed tracing with OpenTelemetry SDK

Host: GitHub
URL: https://github.com/nioc/node-red-contrib-opentelemetry
Owner: nioc
License: lgpl-3.0
Created: 2023-03-08T15:22:24.000Z (about 2 years ago)
Default Branch: master
Last Pushed: 2025-03-16T13:53:11.000Z (2 months ago)
Last Synced: 2025-04-12T23:08:22.799Z (about 1 month ago)
Topics: node-red, node-red-contrib, opentelemetry, otel, prometheus-exporter
Language: JavaScript
Homepage: https://flows.nodered.org/node/node-red-contrib-opentelemetry
Size: 613 KB
Stars: 9
Watchers: 2
Forks: 8
Open Issues: 2
Metadata Files:
- Readme: README.md
- License: LICENSE.md

Awesome Lists containing this project

README

        # Node-RED OpenTelemetry

[![license: LGPLv3](https://img.shields.io/badge/license-LGPL--3.0--or--later-blue.svg)](https://www.gnu.org/licenses/lgpl-3.0)

[![GitHub release](https://img.shields.io/github/release/nioc/node-red-contrib-opentelemetry.svg)](https://github.com/nioc/node-red-contrib-opentelemetry/releases/latest)

[![GitHub Lint Workflow Status](https://img.shields.io/github/actions/workflow/status/nioc/node-red-contrib-opentelemetry/commit.yml?label=lint)](https://github.com/nioc/node-red-contrib-opentelemetry/actions/workflows/commit.yml)

[![GitHub Publish Workflow Status](https://img.shields.io/github/actions/workflow/status/nioc/node-red-contrib-opentelemetry/publish.yml?label=publish)](https://github.com/nioc/node-red-contrib-opentelemetry/actions/workflows/publish.yml)

[![npm](https://img.shields.io/npm/dt/node-red-contrib-opentelemetry)](https://www.npmjs.com/package/node-red-contrib-opentelemetry)

Distributed tracing with OpenTelemetry SDK and Prometheus metrics exporter for Node-RED

## Key features

### Traces

- based on [OpenTelemetry JavaScript framework](https://github.com/open-telemetry/opentelemetry-js) and [Node-RED messaging hooks](https://nodered.org/docs/api/hooks/messaging):

  - create spans on `onSend(source)` and `postDeliver(destination)` events,

  - end spans on `onComplete` and `postDeliver(source)` events.

- trace includes:

  - message id,

  - flow id,

  - node id,

  - node type,

  - node name (if filled),

  - hostname,

  - optional `http status code` (for request node type),

  - optional `exception`,

  - optional custom attributes based on message data.

![Example spans in JaegerUI](https://raw.githubusercontent.com/nioc/node-red-contrib-opentelemetry/master/docs/Screenshot_01.png "Example spans")

![Example spans to metrics in Grafana](https://raw.githubusercontent.com/nioc/node-red-contrib-opentelemetry/master/docs/Screenshot_02.png "Example spans to metrics")

### Metrics

- export of request metrics from `http in` nodes (for Prometheus scraping):

  - method,

  - route,

  - status,

  - ip

  - duration.

``` bash

curl http://localhost:1881/metrics

# HELP target_info Target metadata

# TYPE target_info gauge

target_info{service_name="Node-RED",telemetry_sdk_language="nodejs",telemetry_sdk_name="opentelemetry",telemetry_sdk_version="1.30.0"} 1

# HELP http_request_duration Response time for incoming http requests in milliseconds

# UNIT http_request_duration ms

# TYPE http_request_duration histogram

http_request_duration_count{method="POST",route="/api/test",status="201",ip="127.0.0.1"} 5

http_request_duration_sum{method="POST",route="/api/test",status="201",ip="127.0.0.1"} 620

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="0"} 0

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="25"} 0

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="50"} 4

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="75"} 4

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="100"} 4

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="250"} 4

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="500"} 4

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="1000"} 5

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="2000"} 5

http_request_duration_bucket{method="POST",route="/api/test",status="201",ip="127.0.0.1",le="+Inf"} 5

```

## Installation

Search `node-red-contrib-opentelemetry` within the palette manager or install with npm from the command-line (within your user data directory):

``` bash

npm install node-red-contrib-opentelemetry

```

As with every [node installation](https://nodered.org/docs/user-guide/runtime/adding-nodes), you will need to restart Node-RED for it to pick-up the new nodes.

## Usage

### Traces

- Add OTEL node **once** (to any flow),

- Setup the node:

  - set OTEL [exporter](https://opentelemetry.io/docs/instrumentation/js/exporters/) url (example for Jaeger: `http://localhost:4318/v1/traces`),

  - choose an OTLP transport protocol (`http/json` or `http/protobuf`),

  - define a service name (will be displayed as span service),

  - define an optional root span prefix (will be added in Node-RED root span name),

  - define nodes that should not send traces (using comma-separated list like `debug,catch`),

  - define nodes that should propagate [W3C trace context](https://www.w3.org/TR/trace-context/#design-overview) (in http request headers, using comma-separated list like `http request,my-custom-node`),

  - define time in seconds after which an unmodified message will be ended and deleted,

  - define custom attributes you want to send (optionally).

### Metrics

- Add Prometheus node **once** (to any flow),

- Setup the node:

  - set Prometheus export port and endpoint (example: `1881` and `/metrics`),

  - define a service name (will be displayed in export),

  - define a instrument name (will be displayed in export),

- Add middleware to your `settings.js` file:

  ``` js

    // import the prometheus middleware

    const { prometheusMiddleware } = require('node-red-contrib-opentelemetry/lib/prometheus-exporter.js')

    // ...

    // then add it to the existing httpNodeMiddleware attribute

    httpNodeMiddleware: prometheusMiddleware,

    // ...

  ```

## Versioning

node-red-contrib-opentelemetry is maintained under the [semantic versioning](https://semver.org/) guidelines.

See the [releases](https://github.com/nioc/node-red-contrib-opentelemetry/releases) on this repository for changelog.

## Contributors

- **[Nioc](https://github.com/nioc/)** - _Initial work_

- **[Wodka](https://github.com/wodka/)** - _AMQP headers and `CompositePropagator` (Jaeger, W3C, B3)_

- **[Akrpic77](https://github.com/akrpic77/)** - _MQTT v5 context fields_

- **[joshendriks](https://github.com/joshendriks/)** - _Protobuf trace-exporter support_

See also the full list of [contributors](https://github.com/nioc/node-red-contrib-opentelemetry/graphs/contributors) to this project.

## Direct dependencies

- **[@opentelemetry](https://github.com/open-telemetry/opentelemetry-js)** (Apache-2.0)

- **[jmespath](https://github.com/jmespath/jmespath.js)** (Apache-2.0)

- **[on-finished](https://github.com/jshttp/on-finished)** (MIT)

## License

This project is licensed under the GNU Lesser General Public License v3.0 - see the [LICENSE](LICENSE.md) file for details

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Awesome

https://github.com/nioc/node-red-contrib-opentelemetry

Awesome Lists containing this project

README