osgaga/mqtt2otel repository overview

⁠Introduction

mqtt2otel is a powerful yet lightweight bridge between the MQTT messaging protocol—commonly used in the IoT (Internet of Things) context—and OpenTelemetry (Otel) protocol, which is typically used for professional application and infrastructure monitoring. The tool can subscribe to MQTT broker topics, process and enrich messages with additional information, and then generate Otel metrics or logs for further analysis using standard tools.

⁠Further information

More information on mqtt2otel can be found at the official home page⁠.

⁠Volumes

To install the application with docker you need to create two volumes first:

As a simple ApplicationSettings.yaml file you can use the following:

Logging:
  LogToConsole: true
  MinimumLogLevel: Information  

Copy this into the config directory and name it ApplicationSettings.yaml.

If no application settings file is found the application creates a new ApplicationSettings.yaml file using default values in the /config path.

Then copy your manifest file in the data directory and name it Manifest.yaml. Further information about manifests and an example Manifest.yaml can be found here⁠.

⁠Docker

With that we can now start the docker container via:

docker run -d \
  --restart=always \
  -v MyVolume/config:/config \
  -v MyVolume/manifests:/data \
  "osgaga/mqtt2otel:latest"

⁠Docker-compose

Or if you are using docker-compose:

version: "3.9"

services:
  mqtt2otel:
    container_name: mqtt2otel
    image: "osgaga/mqtt2otel"
    volumes:
      - ./config:/config
      - ./manifests:/data

and then

docker-compose up -d