DOCS / GUIDES

Observability: counting eggs

Instrument your app with metrics, logs, and traces that you will actually read.

Intermediate14 min read
Before you beginYou need the cluck CLI, a Pollosoft account, and a coop to work in. No prior experience required. Curiosity and a mild fondness for chickens are helpful.

Overview

Instrument your app with metrics, logs, and traces that you will actually read. The whole thing takes about 14 minutes, and the commands below are the ones you will use along the way.

$ cluck egg trace enable
$ cluck scratch --follow
$ cluck dash open

Steps

  1. Instrument. Add the PecKit tracing middleware. It adds a trace ID to every request and every log line.
  2. Pick metrics that matter. Start with the four golden eggs: latency, traffic, errors, and saturation.
  3. Build a dashboard. Use Yolkboard to build one dashboard per service. If you need to scroll, it has too many charts.
  4. Alert on symptoms. Alert on what users feel, not on every internal flutter. Fewer, better alerts.

Commands used

Keep going

Stuck? Check the error codes, the FAQ, or the glossary.