How stolostron/multicluster-observability-operator works
This repository implements Open Cluster Management Observability: operators configure hub and managed-cluster monitoring, managed-cluster collectors send metrics to the hub, and hub services expose data for dashboards and queries. The main workflow runs from MCO orchestration through addon distribution and endpoint collection to the observability API; the RBAC query proxy and dashboard loader provide separate access paths. The README documents several external data-plane components whose implementations are outside this repository. Links reflect README statements or shown source references; unsampled components are represented only where documented capabilities support them.
Main entry points: multiclusterobservability_controller.go MCO Operator · observabilityaddon_controller.go Endpoint Operator · proxy.go RBAC Query Proxy · main.go Metrics Collector
Components 23
Hub Orchestration
- MCO Operator
operators/multiclusterobservability/controllers/multiclusterobservability/multiclusterobservability_controller.go - Addon Placement
operators/multiclusterobservability/controllers/placementrule/placementrule_controller.go
Cluster Collection
- Endpoint Operator
operators/endpointmetrics/controllers/observabilityendpoint/observabilityaddon_controller.go - MCOA Agent
operators/endpointmetrics/controllers/mcoa/mcoa_agent_controller.go - Metrics Collector
collectors/metrics/cmd/metrics-collector/main.go - Metrics Forwarder
collectors/metrics/pkg/forwarder/forwarder.go - Metrics Client
collectors/metrics/pkg/metricsclient/metricsclient.go - Prometheus And CMO
Query And Dashboards
- RBAC Query Proxy
proxy/pkg/proxy/proxy.go - Cluster Informer
proxy/pkg/informer/informer.go - Query Modifier
proxy/pkg/metricquery/modifier.go - Grafana
- Dashboard Loader
loaders/dashboards/pkg/controller/dashboard_controller.go
Observability Services
- Observatorium API
- Thanos Ecosystem
- Object Storage
- Alertmanager
Analytics And Status
- Rightsizing Analytics
operators/multiclusterobservability/controllers/analytics/rightsizing/rightsizing_controller.go - Operator Status
operators/multiclusterobservability/controllers/status/status_controller.go - Endpoint Status
operators/endpointmetrics/controllers/status/status_controller.go
Other components
- Cluster Admin
- External Endpoint
- Web Browser
Connections 24
- Cluster Admin → MCO Operator: configures
README.md - MCO Operator → Addon Placement: orchestrates
operators/multiclusterobservability/controllers/multiclusterobservability/multiclusterobservability_controller.go - Addon Placement → Endpoint Operator: distributes addon
README.md - MCO Operator → Observatorium API: deploys data plane
README.md - Endpoint Operator → Metrics Collector: configures
operators/endpointmetrics/controllers/observabilityendpoint/observabilityaddon_controller.go - Endpoint Operator → Prometheus And CMO: configures monitoring
README.md - MCOA Agent → Prometheus And CMO: reconciles config
operators/endpointmetrics/controllers/mcoa/mcoa_agent_controller.go - Metrics Collector → Metrics Forwarder: starts workers
collectors/metrics/cmd/metrics-collector/main.go - Metrics Forwarder → Metrics Client: uses client
collectors/metrics/pkg/forwarder/forwarder.go - Metrics Collector → Observatorium API: remote writes
README.md - Prometheus And CMO → Alertmanager: forwards alerts
README.md - Observatorium API → Thanos Ecosystem: forwards requests
README.md - Observatorium API → External Endpoint: remote writes
README.md - Thanos Ecosystem → Object Storage: stores data
README.md - Thanos Ecosystem → Alertmanager: sends alerts
README.md - Web Browser → Grafana: accesses
README.md - Grafana → RBAC Query Proxy: queries via
README.md - RBAC Query Proxy → Observatorium API: proxies queries
README.md - RBAC Query Proxy → Cluster Informer: uses cluster data
proxy/pkg/proxy/proxy.go - RBAC Query Proxy → Query Modifier: modifies queries
proxy/pkg/proxy/proxy.go - Dashboard Loader → Grafana: updates dashboards
loaders/dashboards/pkg/controller/dashboard_controller.go - MCO Operator → Rightsizing Analytics: registers controller
- MCO Operator → Operator Status: registers controller
- Endpoint Operator → Endpoint Status: reports conditions
operators/endpointmetrics/controllers/observabilityendpoint/observabilityaddon_controller.go