priobike-prometheus

This repository contains a custom Prometheus setup and a custom Node Exporter setup.

The node exporter is configured to insert metadata about the current node name into the exported metrics. In this way, we can run one instance of the node exporter on each physical node and monitor the deployment load. This feature is used by https://github.com/priobike/priobike-load-service

We use this repository to build our own prometheus image with our configuration (prometheus.yml) baked in.

Learn more about PrioBike

What else to know

⚠️ Don't merge main/stable/release branch ⚠️

Similar to our priobike-deployment-docker repo, those branches include deployment specific differences and are diverging on purpose.

Example node exporter deployment

node-exporter:
  image: bikenow.vkw.tu-dresden.de/priobike/priobike-prometheus-node-exporter:main
  environment:
    - NODE_ID={{.Node.ID}}
  volumes:
    - /proc:/host/proc:ro
    - /sys:/host/sys:ro
    - /:/rootfs:ro
    - /etc/hostname:/etc/nodename
  command:
    - '--path.sysfs=/host/sys'
    - '--path.procfs=/host/proc'
    ########################################################################
    # The "docker-entrypoint.sh" script creates a file with 
    # the custom metric "note_meta" to the "/tmp/node-exporter/" directory.
    # See: https://github.com/prometheus/node_exporter#textfile-collector
    ########################################################################
    - '--collector.textfile.directory=/tmp/node-exporter/'
    - '--collector.filesystem.ignored-mount-points=^/(sys|proc|dev|host|etc|tmp)($$|/)'
    - '--no-collector.ipvs'
  deploy:
    # Deploy 1 instance on each node
    mode: global
    endpoint_mode: dnsrr
    restart_policy:
      condition: any

Contributing

We highly encourage you to open an issue or a pull request. You can also use our repository freely with the MIT license.

Every service runs through testing before it is deployed in our release setup. Read more in our PrioBike deployment readme to understand how specific branches/tags are deployed.

Anything unclear?

Help us improve this documentation. If you have any problems or unclarities, feel free to open an issue.