Manage many OpenTelemetry Collectors with OpAMP and Git
Run a fleet of OpenTelemetry Collectors with Myriarch: Git holds the frame, an OpAMP server rolls changes out in waves, and every action is audited.
How-to guides
Step-by-step guides for the common jobs: enrolling hosts, validating the GitOps repository, rolling out changes and trying things locally.
Each page is a how-to guide: it solves one job from start to finish and assumes that you know what you want to achieve. The concepts explain why the system behaves as it does, and the reference lists every option. To learn the system from the start, use the tutorials.
| Guide | What it covers |
|---|---|
| Manage many collectors with OpAMP and Git | Set up the server, a GitOps repository, the hosts and the first rollout. |
| Connect a host | Enroll a Linux or Windows host with one command from the server (dialog Add host), or with the installation scripts on the manual path. |
| Validate a GitOps repository | Check and render configuration with myrctl, locally and in CI. |
| Roll out a configuration change | Waves, approval, failure handling and rollback for a blueprint change. |
| Roll out a collector version | Version updates with the updater, webhook or AWX executor, and the choice in the UI within the Git frame. |
| Upgrade the Collector on many hosts | Set the target version in Git and roll it out with an executor, when the supervisor cannot. |
| Track releases and send notifications | Upstream release tracking, breaking changes and notification channels. |
| Simulate a fleet | Thousands of simulated supervisors and updaters with myriarch-sim. |
| Connect a real supervisor | The upstream OpAMP Supervisor and otelcol-contrib on your machine. |
| Run two replicas locally | Leader election and failover with two myriarchd replicas. |
To start your own GitOps repository, begin with the template described in gitops-template/README.md. The pages from “Roll out a configuration change” on assume the running system of Local development. For operating a real installation see Operations.
Connect a host
Enroll a Linux or Windows host, with one command from the server or with the installation scripts: the inputs, the commands, what to do when it stops.
Set up a GitOps repository
Start your own GitOps repository from the generic template, with fleets, blueprints and rollout policies.
Validate a GitOps repository
Check a GitOps repository and render collector configurations with myrctl, on your machine and in a CI pipeline.
Roll out a configuration change
Change a blueprint in Git and watch the rollout engine apply it in waves, with approval, failure handling and rollback.
Roll out a collector version
Update the collector version of a fleet with the updater, webhook or AWX executor, and choose the version in the UI within the frame set by Git.
Upgrade the OpenTelemetry Collector on many hosts
Change the collector version of a whole fleet when the OpAMP Supervisor cannot: set the target in Git, pick an executor and roll it out in waves.
Track releases and send notifications
Follow upstream collector releases, review breaking changes before raising a target version, and route events to Teams, Slack or a signed webhook.
Simulate a fleet
Connect thousands of simulated supervisors, collectors and updaters to a server with myriarch-sim, using ready-made profiles.
Connect a real supervisor
Run the upstream OpAMP Supervisor and otelcol-contrib on your machine against a local server and watch the whole chain work.
Run two replicas locally
Start two myriarchd replicas on one database, see the leader election and test a failover on your machine.