Generic Exporter Operator
The Generic Exporter operator is a Juju charm that deploys and manages any snap that exposes a Prometheus-compatible metrics endpoint. It is intended to be a small, reusable subordinate charm that:
- Installs and configures a single exporter snap on a unit
- Exposes its metrics over HTTP on a configurable port and path
- Forwards metrics and alert rules to the Canonical Observability Stack (COS) via Opentelemetry Collector using the
cos-agentrelation.
The Generic Exporter operator is machine-only and subordinate. It is designed to be attached to any principal machine charm that needs exporter-style metrics, without requiring a bespoke observability charm for each product.
In this documentation
| Tutorial Get started – a hands-on introduction to deploying and using the Generic Exporter operator. |
How-to guides Step-by-step guides for common operational tasks. |
| Explanation Concepts – key design and architectural details. |
Reference Technical details – configuration, relations, and actions. |
Project and Community
The Generic Exporter operator is an open source project that welcomes contributions, suggestions, and bug reports.
- Read the Code of Conduct.
- Contribute and report issues.
- Explore the Juju SDK documentation for guidelines on writing and enhancing charms.
License
The Generic Exporter operator is free software, distributed under the Apache Software License, version 2.0. For details, see the LICENSE file.
Navigation
Mapping table
| Level | Path | Navlink |
|---|---|---|
| 1 | tutorial | Tutorial |
| 1 | how-to | How to |
| 2 | integrate-with-cos | Integrate with COS |
| 2 | attach-alert-rules | Attach alert rules from a resource |
| 1 | explanation | Explanation |
| 2 | system-architecture | System architecture |
| 2 | charm-lifecycle | Charm lifecycle |
| 1 | reference | Reference |
| 2 | actions | Actions |
| 2 | configurations | Configurations |
| 2 | integrations | Integrations |