agentleFS
DankosikDankosik/golang-backend-skills/skills/go-observability/SKILL.md

go-observability

Skill0 starsChanged 2 months agoMITView on GitHub

Implement or review Go logs, metrics, traces, probes, and lifecycle signals for a concrete operational question.

1 other project uses a version of this.

Adopted by

Most recently taken up by

The file

We split this skill into the rules it gives an agent

3 rules. About 0 are common, 3 are distinctive, and 0 are very specific to this project.

  • ≈0

    Common · estimate

    Many files like this have a rule of this kind.

  • ≈3

    Distinctive · estimate

    This author's own choices. Worth a look.

  • 0

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Operability: Start with the operational question and choose the smallest signal that answers it.

    line 8
  2. Distinctive:

    Follow the affected business operation through existing instrumentation.

    line 10
  3. Distinctive:

    When probes change, treat them as control inputs: liveness describes local progress and readiness describes ability to serve.

    line 16

≈ “Common” is an estimate: at least 1 in 5 of the 350,495 skill files we read have a rule of the same kind, not the same words. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Go Observability

Operability. Start with the operational question and choose the smallest signal that answers it. Honor requirements and preserve settled choices outside the requested change.

Follow the affected business operation through existing instrumentation. Reuse the project's logger, registries, and instrumented clients. Preserve its telemetry stack; a supported standard API can fill a gap without requiring a logging or tracing migration.

Use metrics for aggregate rates, latency, failures, and saturation; traces for an operation's path; logs for actionable events. Bound metric dimensions by their possible combinations. Prefer route templates and finite outcomes to raw paths, user IDs, or error messages. Distinguish logical outcomes from retry attempts and response completion from durable business completion.

Propagate correlation through the actual context and goroutine boundaries. Give spans an owner and an end on every exit. Keep structured errors useful while excluding secrets and sensitive payloads; caller-provided correlation is not trusted identity.

When probes change, treat them as control inputs: liveness describes local progress and readiness describes ability to serve. Consider the platform's response to a shared dependency failure. When diagnostic surfaces change, restrict access and account for profiling overhead.

When lifecycle signals or flushing change, observe admission, in-flight work, cleanup, and telemetry flushing within the shutdown budget. For an ordinary signal edit, verify its output, relevant failure behavior, cardinality, and absence of duplication without adding a lifecycle audit. Finish when the requested question is answerable, distinguishing local checks from deployment evidence; diagnosis or review-only work does not authorize edits.

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.