octonet_exporter/README.md
2026-09-15 23:47:12 +02:00

1.0 KiB

Octonet Exporter

This is a Java application that exports metrics from a Digital Devices OctopusNET to Prometheus.

How to run?

  • Option 1: Set the OCTONET_IP environment variable to the IP address of your OctopusNET device and run the application using mvn exec:java.
  • Option 2: There's are pre-built binary supplied in the download archive. You can use this by setting the OCTONET_IP environment variable to the IP address of your OctopusNET device and then run the application using java -jar octonet-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar.
  • Option 3 (recommended): Use the provided Dockerfile to build a container and run this application in Docker or Podman. Don't forget to supply an -e OCTONET_IP=<your_octonet_ip> to the container.

How to compile a binary?

To compile a binary, run mvn clean compile assembly:single in the project directory. This will create a JAR file in the target directory that you can run using java -jar octonet-exporter-1.0-SNAPSHOT-jar-with-dependencies.jar.