Skip to content

Latest commit

 

History

History
40 lines (30 loc) · 2.21 KB

INTEGRATING.md

File metadata and controls

40 lines (30 loc) · 2.21 KB
Raw

Integrating Prometheus Charmed Operator

Prometheus Charmed Operator integrates with the following:

  1. Any charm that supports the prometheus_scrape interface in serving as a scrape target for Prometheus. This integration is done using the Prometheus Charm library. The documentation of the charm library, available through Charmhub. A scrape target charm provides the Prometheus charm information necessary to construct scrape configurations for the target. This information exchanged through the prometheus_scrape interface can be broken down into three parts

  • A scrape job specification that includes host addresses, ports and paths of one or more OpenMetrics endpoints. A scrape job specification may also include labels that annotate metrics obtained from that endpoint. The Prometheus charm will however ensure that all metrics do have labels that indicate the source of metrics and alerts, within the Juju charm ecosystem.

  • Scrape metadata that is used by the Prometheus charm to add labels to all metrics and alerts.

  • Alert rules which that tell Prometheus when to raise alerts. This rules are read from a directory named prometheus_alert_rules, if present at the top level, within the scrape target charm's source (src) folder.

Any time new relations are made, or existing ones changed, between the Prometheus charm and any scrape target charm, a new Prometheus configuration is generated.

  1. Grafana Charmed Operator, over the grafana_datasource interface, to provide a dashboard for viewing metrics aggregated by Prometheus. These dashboards may be customised by charms that relate to Grafana.

  2. Alertmanager Charmed Operator, over the alertmanager interface, so Prometheus may forward alerts to it.

  3. Traefik Charmed Operator, over the ingress_per_unit interface, so Prometheus may be reached from outside the Kubernetes cluster it is running on.

  4. Catalogue Charmed Operator, over the catalogue interface, so Prometheus can be published in the service catalogue web page.