Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamping argoCD observability documentation (operator manual) #22248

Open
jsolana opened this issue Mar 7, 2025 · 1 comment
Open

Revamping argoCD observability documentation (operator manual) #22248

jsolana opened this issue Mar 7, 2025 · 1 comment
Labels
enhancement New feature or request

Comments

@jsolana
Copy link
Contributor

jsolana commented Mar 7, 2025

Summary

The goal of this issue is to improve the Argo CD observability documentation by gathering real-world monitoring practices. This will allow us to refine the Operator Manual with best practices for logs, alerts, and dashboards, ensuring clearer and more actionable guidance for users.

Motivation

While the current documentation covers basic observability aspects such as metrics, it lacks comprehensive examples and best practices for:

  • Prometheus dashboards – Essential PromQL queries and panel definitions.
  • Logs – Key log events that are crucial for monitoring.
  • Alerts – PromQL queries and alert rules that help maintain stability.

A well-documented observability strategy is essential for efficient troubleshooting and performance optimization. By structuring this information properly, we can make ArgoCD easier to monitor, debug, and scale.

Proposal

The proposal is to update the existing observability documentation by filling in missing aspects.

To ensure the most comprehensive and objective improvements, we aim to gather community feedback on how users monitor and operate Argo CD in real-world scenarios. Their insights will help refine the documentation with practical best practices, making it a more valuable resource for all users.

Also related, an as @crenshaw-dev suggested here, we should better-maintain the Grafana dashboard. I think the demo instance is broken. Fixing that would be a great first step.

@jsolana jsolana added the enhancement New feature or request label Mar 7, 2025
@jsolana
Copy link
Contributor Author

jsolana commented Mar 7, 2025

Hi! I can work on this issue if it is ok 😄

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant