mcpField
O
observability-fundamentals

observability-fundamentals

github.com/honeycombioCloud & DevOps2855 installsUpdated 3w ago
Repository

About observability-fundamentals

A conceptual skill for engineers learning Honeycomb's approach to observability. It explains wide events, dimensional analysis, and an investigation loop, connecting instrumentation choices to root-cause analysis.

Key features

  1. 01Explains wide events and spans
  2. 02Distinguishes events, metrics, and logs
  3. 03Describes cardinality and dimensionality
  4. 04Outlines an investigation analysis loop
  5. 05Links instrumentation to root-cause analysis

Use cases

  1. 01Choosing useful telemetry attributes
  2. 02Understanding event-based observability
  3. 03Structuring incident investigations
  4. 04Identifying instrumentation gaps

Install

Copy the command and run it in a terminal.

$npx skills add https://github.com/honeycombio/agent-skill --skill observability-fundamentals

After installing, type/observability-fundamentalsin Claude Code to confirm it loaded.

Bundled filesreferences/events-vs-metrics-vs-logs.md

Details

From the project README

Observability Fundamentals

First principles behind Honeycomb's approach to observability. Use this to ground recommendations and answer conceptual questions — for SDK setup and tool-specific guidance, see the otel-instrumentation and query-patterns skills.

Definitions

Observability: The ability to understand and explain any state your system can get into, no matter how novel or complex — by examining what the system produces, without deploying new code for each new question.

Wide event: A flat key-value record capturing the full context of a unit of work — who made the request, which endpoint, cache hit/miss, build version, duration, error status, and any business context relevant to the operation. In OpenTelemetry, a span is a wide event.

High cardinality: The number of unique values a field can have. user.id with millions of values is high cardinality. http.method with a handful is low cardinality.

High dimensionality: The number of distinct fields on your events. A span with 50 attributes has high dimensionality.

ConceptObservabilityTraditional Monitoring
QuestionsArbitrary, unknown ahead of timePre-defined (dashboards, alerts)
Data shapeDecided at query timeDecided at instrumentation time
CardinalityHigh cardinality is valuableHigh cardinality is expensive
InvestigationExplore → narrow → confirmCheck dashboard → escalate

Why Wide Events

The shape of the data you collect constrains the questions you can ask later. Metrics pre-aggregate context away at instrumentation time. Wide events preserve context and let you decide the shape of your analysis at query time.

Every attribute on a span is a queryable dimension. Adding user.id, deployment.version, and cache.hit to the same span lets you correlate them in a single query — "slow requests are from tenant X on version 2.3.1 with cache misses." Separate metrics can't do this because each dimension combination creates a new time series.

Honeycomb's storage engine handles high cardinality and dimensionality without the cost explosion that affects metrics systems. Adding a high-cardinality field like user.id doesn't create millions of time series — it's another column on each event, aggregated at query time.

Events vs Metrics vs Logs

Structured Events (Spans)MetricsLogs
CapturesFull request context (all attributes)Pre-aggregated numbers with low-cardinality tagsText or structured fields per line
DiscardsNothing — raw events retainedIndividual requests, high-cardinality dimensionsCorrelation across lines (without trace context)
Query powerGROUP BY, filter, BubbleUp on any dimensionFast aggregates on pre-defined dimensionsText search, structured field queries
Cost scalingLinear with event volumeExponential with dimension count (cardinality)Linear with volume, query cost varies
Best forInvestigation, root cause analysisCheap alerting, long-term trendsAudit trails, rare events

The same instrumentation effort that produces a metric or log line can produce a wide event — and the event gives you all three capabilities: count it (metric), read it (log), analyze it across dimensions (observability).

For code examples showing the same operation instrumented three ways, see ${CLAUDE_PLUGIN_ROOT}/skills/observability-fundamentals/references/events-vs-metrics-vs-logs.md.

The Core Analysis Loop

Debugging in Honeycomb follows a loop: Define → Visualize → Investigate → Evaluate.

  1. Define — Frame the question. Start from an alert, SLO budget burn, or user report.
  2. Visualize — Run a query to see the shape of the problem (HEATMAP, COUNT, P99).
  3. Investigate — Narrow down with BubbleUp (automated outlier-vs-baseline comparison across all dimensions) and trace analysis.
  4. Evaluate — Confirm the hypothesis by querying with and without the suspected cause.

Then loop — each answer raises new questions. BubbleUp automates steps 2-3 by comparing distributions across every column, but it only works if events have enough dimensions to diff on.

For the structured workflow that implements this loop with Honeycomb's tools, see the production-investigation skill.

Instrumentation Connects to Investigation

Every attribute on a span is a dimension BubbleUp can use to find root causes. The attributes that matter most during incidents answer three questions:

  • Who is affected? — user, tenant, account tier, region
  • What changed? — deployment version, feature flag, config version
  • Where is the bottleneck? — business operation spans, timing breakdowns, cache state

Instrument for the questions you'll ask at 3am, not for completeness. If BubbleUp returns nothing useful during an investigation, the issue is usually an instrumentation gap — add the missing dimensions and try again.

For the complete attribute catalog, see ${CLAUDE_PLUGIN_ROOT}/skills/otel-instrumentation/references/wide-event-attributes.md. For SDK guidance on adding attributes, see the otel-instrumentation skill.

Instrumentation as a Development Practice

Instrumentation is not a one-time setup task. The engineers who write the code are best positioned to know which operations are critical, which paths are error-prone, and what context helps during debugging. Treat instrumentation like testing: plan telemetry when planning features, review it in code reviews, and add missing dimensions as post-incident follow-ups.

Additional Resources

Reference Files
  • ${CLAUDE_PLUGIN_ROOT}/skills/observability-fundamentals/references/events-vs-metrics-vs-logs.md — Code examples: same operation as event, metric, and log
Cross-References
  • For SDK setup and custom instrumentation: otel-instrumentation skill
  • For the investigation workflow implementing the core analysis loop: production-investigation skill
  • For autonomous instrumentation gap analysis: instrumentation-advisor agent

Comments

Markdown supported