openmcp-project / openmcp-project/docs
End-User Enablement Guide: How to use the `Metrics Operator` within my ControlPlane
Nobody has claimed this yet.
- Dominant language
- CSS
- Stars
- 1
- Forks
- 7
- Avg merge
- 8d 9h
- Merged PRs (30d)
- 10
Description
Description
The goal of this issue is to write an enablement guide for end-users how they can use a proposed metric tooling to monitor their resources in a ControlPlane.
https://github.com/openmcp-project/backlog/issues/548 evaluated a metric tooling that shall be used within a ControlPlane.
Proposal
Think about how we want to add examples for such metrics in the respective repos to drive end user enablement, see https://github.com/SAP/crossplane-provider-btp/pull/792
Acceptance Criteria
- Enablement guide published unter open-control-plane.io Get stated/end-user section
- End user guide shares commonly used metric examples for reuse
- End user guide demonstrates how to ingest data into any OTEL compatible Data sink [Grafana, Dynatrace, other]
- Proposal how to automatically rotate secrets in the
ControlPlanefor authentication against OTEL backend
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the existing getting-started/end-user section at open-control-plane.io and review backlog issue 548 for the evaluated metric tooling. Use SAP/crossplane-provider-btp pull request 792 as the example reference, then document commonly used metrics, ingestion into an OTEL-compatible sink such as Grafana or Dynatrace, and a proposal for rotating ControlPlane authentication secrets.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- grafana
- Domain
- documentation, observability
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100