Pyroscope Worker Charm (part of Charmed Pyroscope HA)
pyroscope-worker-k8s is a charm that, in conjunction with the pyroscope-coordinator-k8s charm, deploys and operates Grafana Pyroscope, a continuous profiling backend by Grafana Labs.
This charm, together with a coordinator application, handles deployment, scaling, configuration, and Day 2 operations specific to Grafana Pyroscope.
This operator is responsible for running and operating a single instance of the main pyroscope process. It is responsible for applying the configuration generated by the coordinator and monitor the status of the process.
A pyroscope-worker-k8s application will coordinate with other worker applications, mediated by their shared connection to a pyroscope-coordinator-k8s instance, to run a Grafana Pyroscope cluster.
Important! This charm only works in conjunction with its counterpart, and, when deployed in isolation, is not functional. This documentation only contains charm-specific, and as such relatively low-level documentation. For the solution-level documentation, look at the solution-level Charmed Pyroscope HA docs.
This charm is:
- intended to be used together with the
pyroscope-coordinator-k8scharm. - intended to be deployed on top of a COS Lite bundle to extend it with continuous profiling.
This charm, as well as its counterpart, will not be released to the stable channel until we implement profiling support via the otel-collector charm.
In this documentation
| Tutorial Get started - a hands-on introduction for new users deploying the charmed operator. |
How-to guides Step-by-step guides covering key operations and common tasks |
| Explanation Concepts - discussion and clarification of key topics |
Reference Technical information - specifications, APIs, architecture |
Project and community
Charmed Pyroscope is part of the Canonical Observability Stack. It is an open source project that warmly welcomes community projects, contributions, suggestions, fixes and constructive feedback.
- Read our Code of conduct
- Join the Discourse community forum
- Join the Matrix community chat
- Contribute on GitHub
Thinking about using the Canonical Observability Stack for your next project? Get in touch!
Navigation
| Level | Path | Navlink |
|---|---|---|
| 1 | Tutorials | Tutorials |
| 1 | How To | How To |
| 1 | Reference | Reference |
| 1 | Explanation | Explanation |
| 2 | worker-coordinator architecture | The worker-coordinator architecture |