prometheus

Centralized Prometheus Collection

This directory contains resources for building a docker container aiding centralized prometheus collection. It is published to Docker hub at https://hub.docker.com/r/orbcommunity/pktvisor-prom-write

It combines pktvisord with the Grafana Agent for collecting and sending metrics to Prometheus through remote write, including to cloud providers like Grafana Cloud.

There is a sample Grafana dashboard which provides a good starting point for visualizing pktvisor metrics. You can also find it online via the Grafana community dashboards, allowing you to import easily into any Grafana installation (ID 14221).

Example:

docker pull orbcommunity/pktvisor-prom-write
docker run -d --net=host --env PKTVISORD_ARGS="--prom-instance <INSTANCE> <INTERFACE>" \
--env REMOTE_URL="https://<REMOTEHOST>/api/prom/push" --env USERNAME="<USERNAME>" \
--env PASSWORD="<PASSWORD>" orbcommunity/pktvisor-prom-write

Example with Geo enabled (assuming files are located in /usr/local/geo):

docker pull orbcommunity/pktvisor-prom-write
docker run -d --mount type=bind,source=/usr/local/geo,target=/geo --net=host --env \
PKTVISORD_ARGS="--prom-instance <INSTANCE> --geo-city /geo/GeoIP2-City.mmdb --geo-asn /geo/GeoIP2-ISP.mmdb <INTERFACE>" \
--env REMOTE_URL="https://<REMOTEHOST>/api/prom/push" --env USERNAME="<USERNAME>" --env PASSWORD="<PASSWORD>" orbcommunity/pktvisor-prom-write

*PKTVISORD_ARGS optionally allows a semicolon delimited list of arguments to handle arguments such as bpf filters that may contain whitespace

Example with Geo enabled and bpf filter (assuming files are located in /usr/local/geo):

docker pull orbcommunity/pktvisor-prom-write
docker run -d --mount type=bind,source=/usr/local/geo,target=/geo --net=host --env \
PKTVISORD_ARGS="-b; port 53; --prom-instance; <INSTANCE>; --geo-city; /geo/GeoIP2-City.mmdb; --geo-asn; /geo/GeoIP2-ISP.mmdb; <INTERFACE>" \
--env REMOTE_URL="https://<REMOTEHOST>/api/prom/push" --env USERNAME="<USERNAME>" --env PASSWORD="<PASSWORD>" orbcommunity/pktvisor-prom-write

There are a several pieces of information you need to substitute above:

• <INSTANCE>: The prometheus "instance" label for all metrics, e.g. "myhost"
• <INTERFACE>: The ethernet interface to capture on, e.g. "eth0"
• <REMOTEHOST>: The remote host to remote_write the prometheus metric to
• <USERNAME>: If required by your prometheus setup, the user name to connect. If not required, leave off this environment variable.
• <PASSWORD>: If required by your prometheus setup, the password to connect. If not required, leave off this environment variable.

Other pktvisor arguments may be passed in the PKTVISORD_ARGS environment variable.