mqtt2otel

Mqtt broker

Mon, 01 Jan 0001 00:00:00 +0000

The Mqtt broker#

Configuration#

Within the MqttBroker section of the manifest file you can configure how to connect to mqtt brokers. At the moment mqtt2otel does not provide a broker itself so an external one has to be used.

A simple example for a mqtt broker connection would look like that:

1MqttBroker:
2 - Name: "My broker"
3 Endpoint:
4 Port: 1813
5 Protocol: tcp
6 Address: "mymqtt-broker.net"
7 EnableTls: false

It has the following parameters:

Open telemetry server

Mon, 01 Jan 0001 00:00:00 +0000

The Open Telemetry server#

Configuration#

Within the OtelServer section of the manifest file you can configure how to connect to an open telemetry endpoint. At the moment mqtt2otel does not provide an otel collector so an external one has to be used.

A simple example for an otel connection would look like that:

1OtelServer:
2 - Name: "My Otel server"
3 ServiceName: "my-service"
4 ServiceNamespace: "my-service-namespace"
5 Endpoint:
6 Protocol: "http"
7 Port: 4317
8 Address: "my-otel-collector.net"
9 EnableTls: false

It has the following parameters:

Variables

Mon, 01 Jan 0001 00:00:00 +0000

Variables#

Many sections in the manifest support variables. A variable is a simple structure consisting of a key and a value.

Example

1Variables:
2 - Key: DeviceName
3 Value: "MyDevice"

The value is usually a string, but may be any other data type.

To use a variable you will address it with `$key. So the variable as defined above can be used as:

Subscriptions and subscription groups

Mon, 01 Jan 0001 00:00:00 +0000

Mqtt subscriptions and subscription groups#

Configure subscriptions#

To subscribe to a mqtt topic you can use a Subscription section inside a manifst file. It consists of a name and the topic you want to subscribe to.

Example:

1 Subscriptions:
2 - Name: "My subscription name"
3 Topic: "message-topic"
4 Variables:
5 - Key: "SensorName"
6 Value: "MySensor"

It consists of the following parameters:

Processors

Mon, 01 Jan 0001 00:00:00 +0000

Processors#

A processor is responsible for

parsing a mqtt message payload
enriching and transforming the data
translating the data to metrics or logs
sending the data to an otel endpoint.

The basic structure#

General data

Here you can give your processor a name and a desciption. Additionally you can define a default otel server to be used inside the processor.
Mqtt

Here you can configure the mqtt subscriptions that should be processed by the processor.

Quickstart

Mon, 01 Jan 0001 00:00:00 +0000

Quick start#

Installation#

See Installation overview.

Connect to the MQTT Broker and Otel Server#

The mapping between MQTT and Otel is configured via a file called Manifest.yaml. Here’s an example of a simple configuration file that connects to an MQTT broker at http://mymqtt-broker.net:32007 and an OpenTelemetry collector at http://my-otel-collector.net:32014:

 1Version: 1.0
 2
 3MqttBroker:
 4 - Name: "My broker"
 5 Endpoint:
 6 Port: 32007
 7 Address: "mymqtt-broker.net"
 8 EnableTls: false
 9
10OtelServer:
11 - Name: "My Otel server"
12 ServiceName: "my-service"
13 ServiceNamespace: "my-service-namespace"
14 Endpoint:
15 Protocol: "http"
16 Port: 32014
17 Address: "my-otel-collector.net"
18 EnableTls: false

This assumes no credentials are required to log into the broker or the Otel collector. For further configuration options, see Configure MQTT Broker and Configure Otel Server.