Skip to content

Improve observability starter quickstart docs #5

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.

Sign up for GitHub

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

Merged
skyeng2 merged 1 commit into from
Jul 22, 2026
Merged

Improve observability starter quickstart docs #5

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Loading