observability-sentinel

Instrument applications with OpenTelemetry and structured JSON logs.

Updated Oct 31, 2024
One-click install
npx skills add https://github.com/thesammykins/dotfiles --skill observability-sentinel
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: observability-sentinel
Source: https://github.com/thesammykins/dotfiles/tree/main/.agents/skills/observability-sentinel
Command: npx skills add https://github.com/thesammykins/dotfiles --skill observability-sentinel

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Provides a cohesive approach to instrumenting applications with OpenTelemetry, enforcing structured JSON logs with trace context, and bridging logs, metrics, and traces to support Observability Driven Development (ODD).

Core Features & Use Cases

  • Instrument applications using OpenTelemetry SDKs to generate traces, metrics, and logs.
  • Design structured logs (JSON) with correlation IDs to link related events across services.
  • Connect logs, metrics, and traces (the three pillars) to provide unified visibility.
  • Set up Golden Signals (latency, traffic, errors, saturation) to monitor service health and performance.
  • Use cases include configuring logging for Node.js (Winston, Pino), Python logging; debugging distributed systems; and responding to requests to add monitoring or trace requests.

Quick Start

Run a sample app that emits OpenTelemetry traces and JSON-structured logs to verify end-to-end observability.

Frequently Asked Questions about observability-sentinel

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

FAQPage Schema
How do I instrument microservices with OpenTelemetry for distributed tracing?

Instrument microservices with OpenTelemetry by applying auto-instrumentation and manual spans to generate traces, metrics, and logs. This enforces proper span propagation across backend services to achieve end-to-end observability.

How do I correlate structured logs with OpenTelemetry traces across backend services?

Correlate structured logs with traces by designing JSON logs that include correlation IDs and trace context. This bridges logs, metrics, and traces to link related events across distributed systems.

How do I configure Node.js logging libraries like Winston and Pino for observability?

Configure Node.js logging libraries like Winston and Pino by implementing structured JSON logging with trace context. This emits correlated logs that support observability driven development and unify visibility.

What are the Golden Signals for monitoring distributed systems health?

The Golden Signals for monitoring distributed systems health are latency, traffic, errors, and saturation. Setting up these signals monitors service performance and identifies bottlenecks across microservices.

When do I need structured logging and correlation IDs in a distributed system?

You need structured logging and correlation IDs in a distributed system when debugging requests across microservices. They link related events across services to provide unified visibility into application behavior.

Does observability-sentinel support Python logging alongside Node.js instrumentation?

Observability-sentinel supports configuring Python logging alongside Node.js instrumentation. It generates OpenTelemetry traces and JSON-structured logs to verify end-to-end observability across multiple backend languages.