metadata.yaml

# This file populates the Overview on Charmhub.
# See https://juju.is/docs/sdk/metadata-reference for a checklist and guidance.

# The charm package name, no spaces (required)
# See https://juju.is/docs/sdk/naming#heading--naming-charms for guidance.
name: prometheus-juju-exporter

# The following metadata are human-readable and will be published prominently on Charmhub.

display-name: Prometheus Juju Exporter

summary: Charm that exports statistics about number of juju-deployed machines

docs: https://discourse.charmhub.io/t/prometheus-juju-exporter-docs-index/11197

description: |
  This charm exposes a `/metrics` endpoint for Prometheus that provides statistics
  about machines deployed by juju controller. It connects to configured juju controller
  and collects information about machines from every model.

  The metrics provide information about machines' states (UP or DOWN) and can be used
  to calculate how many machines are managed by juju controller and in which state they
  are. For more detailed information about exposed metrics and their format see
  prometheus-juju-exporter snap documentation

  TODO: include link to snap

subordinate: True

resources:
  exporter-snap:
    type: file
    description: |
      (Optional) Snap that implements actual data collection and export. If not provided, charm
      will try to download prometheus-juju-exporter from snap store.
    filename: prometheus-juju-exporter.snap

provides:
  prometheus-scrape:  # Relation with legacy "prometheus2" charm
    interface: prometheus
  prometheus-k8s-scrape:  # Relation with new "prometheus-k8s" charm
    interface: prometheus_scrape
  grafana-k8s-dashboard:
    interface: grafana_dashboard

requires:
  general-info:
    interface: juju-info
    scope: container