From a1d06dbdb54f594b115fc8e9e83e66ee3e785e66 Mon Sep 17 00:00:00 2001 From: leiwilson <305842734+leiwilson@users.noreply.github.com> Date: Wed, 22 Jul 2026 09:02:43 +0100 Subject: [PATCH] Improve observability starter quickstart in README Add a practical traces/metrics/logs checklist so newcomers know what to verify on first deploy. Co-authored-by: Cursor --- README.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/README.md b/README.md index ca401d6..8503885 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,22 @@ Minimal AWS Lambda starter with **structured JSON logging**, a small **metrics helper**, and **local unit tests**. No AWS account or credentials required. +## Observability quickstart + +This starter is meant to get Lambda-style workloads emitting useful signals quickly. + +1. **Traces** — wrap handler entry/exit so cold starts and downstream calls are visible. +2. **Metrics** — emit latency, error count, and at least one business/custom metric. +3. **Logs** — keep structured JSON logs with `request_id` / correlation fields for joins. + +### Minimal checklist before first deploy + +- Confirm the runtime exporter (or OTEL collector sidecar) is configured for your account/region. +- Verify one successful invocation shows up in your observability backend with matching trace + log correlation. +- Fail a canary on purpose once and confirm the error metric and alert path fire. + +See the sample handlers and config in this repo for a concrete wiring pattern you can copy. + ## Features - Structured logger that emits one JSON object per line (CloudWatch-friendly)