Skip to content

SLEAK-5896: stop implying Grafana alert setup in exhaustive testing guide#213

Closed
agustinoli wants to merge 3 commits into
developfrom
fix/SLEAK-5896-grafana-alerts-wording
Closed

SLEAK-5896: stop implying Grafana alert setup in exhaustive testing guide#213
agustinoli wants to merge 3 commits into
developfrom
fix/SLEAK-5896-grafana-alerts-wording

Conversation

@agustinoli

@agustinoli agustinoli commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Removes the "configure alerts in Grafana" wording from the cost-vs-risk intro of environment-exhaustive-testing-guide (EN+ES) — Mati flagged that it implies a how-to we don't cover.
  • Now points readers to reviewing latency/error-rate metrics that aren't included by default in Grafana, keeping the how-to implicit as discussed.
  • Fixes the "Section 6" anchor link, which was already broken (pointed to #section-6-observability while the heading is Section 6: Observability and Alerts).

Ref: SLEAK-5896, follow-up on #201

Test plan

  • make build — no broken anchors on this page (EN+ES)
  • Review wording in preview

Summary by CodeRabbit

  • Documentation
    • Se actualizó la guía para reemplazar la recomendación específica de “configurar alertas en Grafana” por el uso del stack de observabilidad existente para actuar de forma proactiva antes de que el rendimiento se degrade.
    • Se ajustaron las referencias internas del tutorial para alinear el contenido con “Observabilidad y alertas”.
    • En el apartado de “Métricas en Grafana” se redujo el requisito mínimo de dashboards a incluir, como mínimo, CPU y uso de memoria.

Per Mati's review, the cost-vs-risk intro no longer says "configure
alerts in Grafana" — that reads as a how-to we don't cover. It now
points to reviewing latency/error-rate metrics that aren't included
by default. Also fixed the Section 6 anchor link, which was already
broken (missing "y alertas"/"and Alerts" suffix).
@coderabbitai

coderabbitai Bot commented Jul 1, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c817634e-a41d-4031-b12d-72e9b5097394

📥 Commits

Reviewing files that changed from the base of the PR and between f6555f9 and a07db83.

📒 Files selected for processing (2)
  • content/tutorials/en/environment-exhaustive-testing-guide.mdx
  • content/tutorials/es/environment-exhaustive-testing-guide.mdx
✅ Files skipped from review due to trivial changes (2)
  • content/tutorials/es/environment-exhaustive-testing-guide.mdx
  • content/tutorials/en/environment-exhaustive-testing-guide.mdx

Walkthrough

Se actualizan dos apartados de la guía en inglés y español: la recomendación de costo vs. riesgo pasa a apoyarse en la observabilidad existente, y el checklist de Grafana reduce las métricas mínimas exigidas a CPU y memoria.

Changes

Actualización de texto en guía de testing

Layer / File(s) Summary
Ajuste de recomendación costo vs. riesgo
content/tutorials/en/environment-exhaustive-testing-guide.mdx, content/tutorials/es/environment-exhaustive-testing-guide.mdx
Se reescribe la recomendación para usar el stack de observabilidad existente y actuar antes de que el impacto llegue a usuarios; en español también se actualiza el ancla de la sección.
Checklist de métricas en Grafana
content/tutorials/en/environment-exhaustive-testing-guide.mdx, content/tutorials/es/environment-exhaustive-testing-guide.mdx
Se reduce el mínimo de dashboards exigidos en Grafana a CPU usage y memory usage en ambas versiones.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

  • sleakops/docs#201: Incorporó la guía base y las secciones de observabilidad/métricas en environment-exhaustive-testing-guide.mdx en inglés y español.

Suggested reviewers: lucaiz

Poem

Entre métricas y alertas, la guía volvió a brillar,
CPU y memoria bastan para empezar a vigilar.
En sleakops las piñas resuelven el conflicto con humor,
y el texto queda fino, claro y mejor.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed El título describe con precisión el cambio principal: eliminar la implicación de configurar alertas de Grafana en la guía de pruebas exhaustivas.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/SLEAK-5896-grafana-alerts-wording

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

Section 6 already says Grafana dashboards include latency and error
rate by default, so the previous phrasing ("metrics we don't include
by default") contradicted it. What's not on by default is alerting on
those metrics — reworded to say that instead.
@agustinoli

Copy link
Copy Markdown
Contributor Author

Buen catch — la Sección 6 ya asume que las métricas de latencia/error rate vienen por defecto en los dashboards de Grafana, así que decir que "no las incluimos por defecto" contradecía eso. Reescribí la frase (EN+ES) para que el matiz sea sobre las alertas (esas sí no vienen por defecto), no sobre las métricas. Push en 918f283.

Cada sección de esta guía tiene un costo: tiempo de preparación, overhead de infraestructura y esfuerzo de desarrollo. Antes de ejecutar una sección, evaluá si el riesgo que cubre es real para tu aplicación y si la inversión es proporcional.

A veces el mismo riesgo se puede mitigar de forma más económica. En lugar de montar un stack completo de load testing, por ejemplo, podés configurar alertas de latencia y tasa de errores en Grafana que te avisen antes de que el rendimiento degradado llegue a tus usuarios. La observabilidad y las alertas se cubren en la [Sección 6 — Observabilidad](#sección-6-observabilidad).
A veces el mismo riesgo se puede mitigar de forma más económica. En lugar de montar un stack completo de load testing, por ejemplo, podés seguirle el pulso a las métricas de latencia y tasa de errores en Grafana — no configuramos alertas sobre ellas por defecto, así que queda en vos revisarlas de forma proactiva y detectar el rendimiento degradado antes de que llegue a tus usuarios. La observabilidad se cubre en la [Sección 6 — Observabilidad y alertas](#sección-6-observabilidad-y-alertas).

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Porque grafana?

Cost-vs-risk intro now says "any monitoring stack" instead of naming
Grafana specifically. Trimmed the default metrics list in the
Observability section to what dashboards reliably show out of the box.
@agustinoli

Copy link
Copy Markdown
Contributor Author

Cerrado a favor de #216, que consolida los cambios de SLEAK-5896, SLEAK-5875 y el fix de anchor en un solo PR.

@agustinoli agustinoli closed this Jul 1, 2026
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.

2 participants