observability-and-instrumentation

Implement structured logging, metrics, and distributed tracing with OpenTelemetry.

Updated Apr 19, 2026
One-click install
npx skills add https://github.com/dmarins/sdd --skill observability-and-instrumentation-dmarins
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: observability-and-instrumentation
Source: https://github.com/dmarins/sdd/tree/main/skills/observability-and-instrumentation
Command: npx skills add https://github.com/dmarins/sdd --skill observability-and-instrumentation-dmarins

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This skill addresses the challenge of operating software in production by ensuring that code emits the necessary telemetry to diagnose issues, track performance, and verify system health.

Core Features & Use Cases

  • Structured Logging: Implements JSON-based logging with stable event names and correlation IDs to ensure logs are machine-readable and traceable.
  • Metric & Trace Integration: Provides guidance on implementing RED/USE metrics and distributed tracing using OpenTelemetry to monitor system behavior.
  • Alerting Strategy: Defines how to create actionable, symptom-based alerts that minimize noise and provide clear runbooks for on-call engineers.

Quick Start

Use the observability-and-instrumentation skill to audit the current logging and metric implementation for the payment processing service.

Frequently Asked Questions about observability-and-instrumentation

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I implement structured logging with correlation IDs for backend services?

Structured logging is implemented using JSON-based formats with stable event names and correlation IDs to ensure logs are machine-readable and traceable across backend services, API endpoints, and background jobs. This enables reliable production diagnostics.

What is the best way to instrument code for production observability using OpenTelemetry?

Production observability is achieved by implementing vendor-neutral telemetry via OpenTelemetry, combining structured logging, RED/USE metrics, and distributed tracing to monitor system behavior and diagnose issues in backend services.

How do I set up symptom-based alerting to minimize noise for on-call engineers?

Symptom-based alerting is configured by defining actionable alerts tied to specific system symptoms, minimizing noise and providing clear runbooks for on-call engineers to ensure reliable monitoring and rapid diagnosis.

Does this observability instrumentation work for background jobs and API endpoints?

Yes, this instrumentation applies to the development of backend services, API endpoints, and background jobs, providing the necessary telemetry to track performance, verify system health, and diagnose production issues.

What metrics should I track for monitoring system behavior in production?

You should track RED and USE metrics to monitor system behavior effectively. These metrics integrate with distributed tracing and structured logging to provide comprehensive production observability and diagnostic capabilities.

Why do I need vendor-neutral telemetry for distributed tracing?

Vendor-neutral telemetry via OpenTelemetry is needed to implement distributed tracing without lock-in, ensuring that metrics and traces remain portable and interoperable across different monitoring platforms for production observability.