Skip to content

docs: Document automated Prometheus metrics management#3096

Draft
tolusha wants to merge 1 commit into
eclipse-che:mainfrom
tolusha:doc-automated-prometheus-management
Draft

docs: Document automated Prometheus metrics management#3096
tolusha wants to merge 1 commit into
eclipse-che:mainfrom
tolusha:doc-automated-prometheus-management

Conversation

@tolusha
Copy link
Copy Markdown
Contributor

@tolusha tolusha commented May 12, 2026

Summary

This PR documents the automated Prometheus resource management feature introduced in eclipse-che/che-operator#2117.

Changes:

  • Document automatic ServiceMonitor, RBAC, and namespace label creation by the Che Operator
  • Add documentation for new spec.devEnvironments.metrics field to control DevWorkspace Operator metrics
  • Update monitoring procedures to explain the automation (no manual steps required)
  • Add manual configuration guide for troubleshooting scenarios
  • Update CheCluster Custom Resource properties reference with new metrics field

Key improvements:

  • Che Server metrics: The Che Operator now automatically creates ServiceMonitor, Role, RoleBinding, and namespace labels when spec.components.metrics.enable: true (default)
  • DevWorkspace Operator metrics: The Che Operator now automatically creates monitoring resources when spec.devEnvironments.metrics: true (default)
  • Simplified user experience: No manual configuration of Prometheus resources required
  • Self-healing: Resources are automatically recreated if deleted or modified

Related PR

🤖 Generated with automated documentation workflow

Update documentation to reflect automated Prometheus resource management
introduced in eclipse-che/che-operator#2117.

Changes:
- Document automatic ServiceMonitor, RBAC, and namespace label creation
- Add new spec.devEnvironments.metrics field documentation
- Update monitoring procedures to explain automation
- Add manual configuration guide for troubleshooting scenarios
- Update CheCluster properties reference

The Che Operator now automatically manages Prometheus monitoring resources
when metrics are enabled, eliminating the need for manual configuration of
ServiceMonitors, Roles, RoleBindings, and namespace labels.

Related: eclipse-che/che-operator#2117

Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
@github-actions
Copy link
Copy Markdown

github-actions Bot commented May 12, 2026

Click here to review and test in web IDE: Contribute

@github-actions
Copy link
Copy Markdown

⚡️ Deploying pull request preview...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant