Skip to content

docs: document production monitoring, alerting, and degradation detection#37

Merged
KostasCherv merged 1 commit into
mainfrom
docs/production-monitoring
Jul 14, 2026
Merged

docs: document production monitoring, alerting, and degradation detection#37
KostasCherv merged 1 commit into
mainfrom
docs/production-monitoring

Conversation

@KostasCherv

Copy link
Copy Markdown
Owner

Gap

Observability docs covered AI tracing (LangSmith, LangFuse) well but said nothing about production monitoring. The Prometheus/Grafana stack is benchmark-only, and there was no documented metrics, alerting, uptime-check, or degradation-detection story for the Cloud Run deployment — nothing told an operator the service was degraded except a user report.

What this adds

New Production monitoring section in docs/observability.md:

  • Cloud Run built-in metrics that apply (request count, latency percentiles, instance count, startup latency, CPU/memory) and where to view them.
  • A recommended Cloud Monitoring alerting policy: 5xx ratio, p95 latency (with the SSE caveat), probe-failure log alert, and an uptime check against GET /health.
  • "How degradation is detected": which signal fires for each failure class — dependency outage, elevated errors, latency regression, LLM-provider failure, ingestion/outbox stall, full outage.
  • Notes the opt-in Sentry error capture (SENTRY_DSN) and clarifies the Prometheus/Grafana stack stays benchmark-only.

Also: README observability row updated to reference the documented policy instead of implying production dashboards, and a one-line cross-link from docs/deployment.md#health-and-readiness.

Note

Docs-only — this documents operational policy. Alert policies and uptime checks are per-project Cloud Monitoring resources, and the doc is explicit that they are recommended, not provisioned by the deploy scripts. No runtime code changes.

@vercel

vercel Bot commented Jul 14, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
cortex Ready Ready Preview, Comment Jul 14, 2026 2:26pm

@KostasCherv
KostasCherv merged commit 8f9346f into main Jul 14, 2026
5 checks passed
@KostasCherv
KostasCherv deleted the docs/production-monitoring branch July 14, 2026 14:31
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