Communitygithub.com

lguidolin/observabilidad-y-slos

Úsalo al añadir logging, métricas, trazabilidad, health checks, SLOs o alertas — o al construir una superficie de servicio que deba ser operativa y depurable. Palabras clave: logs estructurados, OpenTelemetry, id de correlación, métricas RED, liveness, readiness, SLI, SLO, presupuesto de error, alertas.

¿Qué es observabilidad-y-slos?

Este skill proporciona un enfoque integral para diseñar observabilidad y SLOs en sistemas de software, basado en principios universales como los tres pilares de señales (logs estructurados, métricas y trazas), las señales golden (RED: tasa, errores, duración), y la definición de SLOs para jornadas críticas. Está pensado para plataformas como AKS con Azure Monitor/Log Analytics, OpenTelemetry, y contenedores en Kubernetes. Incluye mecanismos concretos: logs JSON a stdout, propagación de ids de correlación (desde el borde hasta PostGraphile), endpoints de liveness/readiness conectados a probes de Kubernetes, y alertas basadas en síntomas (quema de SLO) en lugar de causas internas. También cubre frontend con web-vitals y errores del cliente reportados al mismo backend. El skill recomienda escalar gradualmente: implementar logs estructurados y health endpoints desde el inicio, y diferir SLOs/alertas hasta que haya usuarios reales. La documentación incluye referencias a una constitución de ingeniería con artículos sobre estos principios.

Compatible con~Claude Code~Codex CLI~Cursor
npx skills add https://github.com/lguidolin/agent-skills/tree/main/skills/observability-and-slos

Preguntar en tu IA favorita

Abre un nuevo chat con esta habilidad de agente ya precargada.

Documentación

Observabilidad y SLOs

Resumen

No puedes operar, depurar o mejorar lo que no puedes ver. La observabilidad se diseña, no se añade después del primer corte de servicio. La primera pregunta en cada incidente es "¿qué cambió y quién está afectado?" — un sistema que no puede responderla convierte una solución de cinco minutos en una excavación arqueológica.

Los principios (universales)

  • Las tres señales. Emite logs estructurados (legibles por máquina, no texto libre), métricas (conteos, tasas, duraciones) y trazas (el recorrido de una solicitud a través de los servicios). Una solicitud lleva un id de correlación/traza de extremo a extremo.
  • Instrumenta las señales golden para cada superficie: tasa, errores, duración (RED) por endpoint/operación, más saturación de recursos. Un nuevo endpoint no está "terminado" hasta que sea observable.
  • La salud es un endpoint, no una suposición. Expone liveness ("¿estoy ejecutándome?") y readiness ("¿puedo servir tráfico?") como comprobaciones diferenciadas.
  • Define SLOs para las jornadas críticas, con SLIs que las midan y un presupuesto de error que convierte la disyuntiva fiabilidad vs. funcionalidades en una decisión explícita y basada en datos.
  • Alerta sobre síntomas, no sobre causas. Notifica cuando los usuarios están sufriendo (quema de SLO, readiness fallando), no ante cada parpadeo interno. Toda alerta debe ser accionable — una alerta que nadie atiende entrena a la gente a ignorar las alertas.

Los mecanismos (este stack)

  • Logs JSON estructurados a stdout, recogidos por la plataforma (ej. AKS → Azure Monitor / Log Analytics). Sin logging de texto libre en los servicios.
  • OpenTelemetry en el servidor de la aplicación y en PostGraphile; exporta trazas/métricas a Azure Monitor / Application Insights (o Prometheus/Grafana).
  • Id de correlación propagado a través de la ruta de datos — generado en el borde, pasado Navegador → Aplicación → PostGraphile junto con cabeceras de contexto, adjunto a cada línea de log y cada span.
  • Métricas RED por ruta HTTP y operación GraphQL; log de consultas lentas de Postgres + pg_stat_statements.
  • Endpoints de liveness/readiness conectados a las probes de Kubernetes (ver cloud-delivery-aks). Readiness refleja la salud real de las dependencias (¿puede alcanzar la BD?), no solo que el proceso esté en ejecución.
  • Frontend: reporta web-vitals y errores de cliente al mismo backend.
  • SLOs por jornada con paneles de control y alertas basadas en tasa de quema.

Cuándo escalar esto

Un proyecto local o pre-lanzamiento implementa logs estructurados + endpoints de salud ahora y pospone SLOs/alertas hasta que haya usuarios reales que proteger. Indica el modo en la primera decisión registrada.

Justificación completa: Artículos IX y XVI de la constitución, incluida en engineering-constitution/references/engineering-constitution.md.

Individual skills in this repo

This repo contains 18 individual skills — each has its own dedicated page.

lguidolin/change-hygiene-and-code-craft

Use when writing or refactoring code, structuring a commit or PR, or deciding whether to abstract duplication. Symptoms — mixing reorg with logic changes, a PR doing several things at once, a file growing large, the second copy of similar code, or unsure whether to DRY something up.

lguidolin/cloud-delivery-aks

Use when deploying to Kubernetes or Azure Kubernetes Service (AKS), configuring cloud secrets, setting up progressive rollout/canary, per-PR ephemeral environments, or k8s health probes. Keywords — Kubernetes, AKS, Key Vault, Argo Rollouts, Flagger, canary, blue-green, liveness, readiness, PodDisruptionBudget, HPA, rollback, GHCR.

lguidolin/commit-history-rewrite

Use when an existing repository has messy commit history that needs to conform to conventional commits before adopting release-please, or when intermediate WIP/fixup/merge commits need to be cleaned up.

lguidolin/conventional-commits-and-releases

Use when committing, writing a commit message, opening a PR that will be squash-merged, or configuring automated versioning/changelogs. Keywords — conventional commits, release-please, semver, feat/fix/chore, breaking change, changelog.

lguidolin/defense-in-depth-security

Use when handling untrusted input, secrets, authentication/authorization, or dependencies — or threat-modeling a new surface. Keywords — STRIDE, threat model, least privilege, secrets management, supply chain, dependency scanning, input validation, audit log, defense in depth.

lguidolin/designing-before-building

Use when starting a feature, fixing a non-trivial bug, or about to write implementation code — before any code exists. Symptoms you need this: "this is simple, I'll just code it", reaching for the editor before a design is approved, or an idea that hasn't been turned into a spec and plan.

lguidolin/engineering-constitution

Use when starting work in a project that follows the engineering constitution, orienting to its rules, or deciding which engineering practice applies to a task — spec writing, commits, testing, security, deploys, database, or UI work.

lguidolin/graphql-contract-testing

Use when writing a GraphQL query/mutation that the UI and a test will share, or building route/schema contract or smoke tests. Symptoms — copying a query into a test, a test asserting on query text, schema change that didn't break the UI build, or RLS/permission drift. Keywords — graphql-codegen, typed document, contract test, route smoke test.

lguidolin/init-repo-CI

Use when setting up a new repository with conventional commits, release-please, and CI automation, or when retrofitting an existing repository that lacks automated versioning and PR validation workflows.

lguidolin/interface-craft-and-accessibility

Use when building or styling UI — components, layouts, forms, design tokens — or making accessibility decisions. Keywords — a11y, WCAG, keyboard navigation, focus state, contrast, design system, minimalist UI, component reuse, ARIA, semantic HTML.

lguidolin/merge-gates-and-automation

Use when setting up or changing CI, pre-push hooks, or a task runner, or deciding what must pass before merge. Symptoms — tempted to put authoritative checks only in a local hook, skip CI, bypass with --no-verify, or unsure what gates a merge vs. runs locally.

lguidolin/performance-and-scale

Use when working on hot paths, list endpoints, pagination, data-access in loops, or public interfaces/schemas. Symptoms — unbounded queries, N+1 access, no latency budget, optimizing without measuring, or changing an interface many consumers depend on. Keywords — pagination, N+1, Hyrum's Law, performance budget, bundle size.

lguidolin/postgres-postgraphile-rls-and-sql

Use when writing PostgreSQL, PostGraphile config, Row-Level Security policies, SQL schema files, or working on the Browser→App→PostGraphile→Postgres data path. Keywords — RLS, SECURITY DEFINER, search_path, pgSettings, grants, roles, GraphQL depth limit, query cost, statement_timeout, SQL file organization.

lguidolin/recording-decisions

Use when a design or architecture decision has been made and needs to be captured — writing a decision record or ADR, updating a decision index, noting a deferred idea, or superseding a past decision. Keywords — ADR, decision record, rationale, rejected alternatives, dependency index.

lguidolin/resilience-and-deploy-safety

Use when planning a deploy, designing a rollback, or responding to an incident or writing a postmortem. Keywords — deploy safety, rollback, immutable artifact, progressive delivery, canary, blast radius, incident response, blameless postmortem, error budget.

lguidolin/ship-it

Use when the user wants to ship work — push, PR, archive decision records, merge, and clean up. Handles the full lifecycle from committing final changes through post-merge cleanup including converting specs/plans to compact decision records.

lguidolin/tests-as-a-control

Use when writing or modifying tests, when a test breaks during a refactor, or when testing permission/role rules. Symptoms — tempted to edit a test to make it pass, testing only the happy path, a deny-test that started passing, flaky tests, or unsure what to assert.

lguidolin/zero-downtime-migrations

Use when changing a database schema where data must survive the change — adding/removing/renaming columns, constraints, indexes, or backfilling. Symptoms — a destructive migration bundled with a code deploy, a NOT NULL column with a backfill, a table-locking UPDATE, or a rename. Keywords — expand/contract, parallel change, backfill, NOT VALID, CREATE INDEX CONCURRENTLY, graphile-migrate.

Skills relacionados