Prometheus juju exporter docs - index

Prometheus Juju Exporter

Prometheus Juju Exporter is a subordinate machine charm that collects statistics about machines deployed by a juju controller and exports them as Prometheus metrics. Core collecting and exporting functionality is implemented in the Prometheus Juju Exporter snap.

Collected Data

The main focus of this exporter is to provide insight about the number of machines managed by the Juju controller and their current states. The installed exporter snap will try to connect to the controller and crawl through every model, collecting information about deployed machines. Resulting metrics contain numeric representation 1 (UP) or 0 (DOWN) for each machine deployed by the controller. In addition, each machine (metric) has labels that help to uniquely identify it:

  • hostname - hostname of the machine as reported by Juju
  • juju_model - name of the model in which the machine is deployed
  • cloud_name - name of the cloud that hosts the model
  • customer - name of the customer/organization that owns the controller
  • type - Distinguishes various host types
  • metal - Physical machine
  • kvm - Virtual Machine
  • lxd - LXD container

Example data:

# HELP juju_machine_state Running status of juju machines
# TYPE juju_machine_state gauge
juju_machine_state{customer="DOC",hostname="juju-882749-controller-0",job="prometheus-juju-exporter",cloud_name="openstack-cloud-serverstack",juju_model="controller",type="kvm"} 1.0
juju_machine_state{customer="DOC",hostname="juju-882749-controller-3",job="prometheus-juju-exporter",cloud_name="openstack-cloud-serverstack",juju_model="controller",type="kvm"} 1.0
juju_machine_state{customer="DOC",hostname="juju-ad368d-test-0",job="prometheus-juju-exporter",cloud_name="openstack-cloud-serverstack",juju_model="test",type="kvm"} 1.0
juju_machine_state{customer="DOC",hostname="juju-ad368d-test-1",job="prometheus-juju-exporter",cloud_name="openstack-cloud-serverstack",juju_model="test",type="kvm"} 1.0

Security, Bugs and feature request

If you find a bug in this application or want to request a specific feature, here are the useful links:

  • Raise issues or feature requests in Github

  • Security issues in the Prometheus juju exporter can be reported through LaunchPad. Please do not file GitHub issues about security issues.

Contributing

Please see the Juju SDK docs for guidelines on enhancements to this charm following best practice guidelines, and CONTRIBUTING.md for developer guidance.

License

Prometheus Juju Exporter is free software, distributed under the Apache Software License, version 2.0. See LICENSE for more information.

Navigation

Level Path Navlink
1 Tutorial Tutorial
1 How to How to
2 h-configure Configure the charm
2 h-verify Verify the deployment
2 h-cos Integrate with COS
1 Explanation Explanation
2 e-security Security
2 e-machine-type How machine type is determined
1 Reference Reference
2 r-resources Resources
2 r-configuration Configuration Options
1 Like