skills.rest
akshay-na
akshay-naCOMMUNITY
Explore all skills by this author →
WebsiteGitHub

observability-as-design

Define metrics, structured logging, and tracing boundaries before implementation.

4|Updated Oct 31, 2024
Search Tags:#design#logging#metrics#observability#reliability#tracing#slo
One-click install
npx skills add https://github.com/akshay-na/dotfiles --skill observability-as-design
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: observability-as-design
Source: https://github.com/akshay-na/dotfiles/tree/main/cursor/.cursor/skills/observability-as-design
Command: npx skills add https://github.com/akshay-na/dotfiles --skill observability-as-design

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

This Skill addresses the critical need to design systems that are inherently observable, ensuring that operational visibility is a core requirement from the outset, rather than an afterthought. It helps prevent outages caused by a lack of necessary signals and blind spots.

Core Features & Use Cases

  • Proactive Measurement: Defines metrics, structured logging, and tracing boundaries before implementation.
  • Failure Simulation & Testing: Guides users to test 2AM scenarios and identify missing signals.
  • Use Case: Before deploying a new microservice, use this Skill to define its RED metrics, structured log schema, and SLO candidates, ensuring that any future issues can be diagnosed quickly and effectively.

Quick Start

Use the observability-as-design skill to define RED metrics for a new API endpoint.

Frequently Asked Questions about observability-as-design

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

FAQPage Schema
How do I define observability metrics and logging boundaries before implementing a microservice?▼

To define observability before implementation, establish RED metrics, structured logging schemas, and tracing boundaries. This approach ensures operational visibility is built-in from the start, preventing blind spots and making systems measurable and debuggable.

What is the best way to build health checks and set SLO targets for a new system?▼

SLO targets are set by identifying SLO candidates and leading indicators during the design phase. This proactive measurement approach ensures operational transparency and system reliability are established before deployment.

How do I test failure scenarios and identify missing signals for system reliability?▼

Failure scenarios are tested by simulating 2AM operational situations to identify missing signals and blind spots. This ensures the predefined metrics, structured logging, and tracing boundaries capture necessary diagnostic information.

Can I use this observability design approach for setting SLO targets on existing APIs?▼

Yes, the approach applies to new API endpoints by defining RED metrics and SLO candidates. It ensures any future operational issues can be diagnosed quickly and effectively through established tracing and logging.

Related Skills

Explore More Software Engineering Skills→
wesleyegbertowesleyegberto
3

microservices-architect

Define service boundaries for distributed systems using domain-driven design.

Community
Advanced
HsienWHsienW
63

observability-and-instrumentation

Instrument code with structured logging, metrics, tracing, and alerting.

Community
Advanced
thc1006thc1006
20

service-mesh-observability

Implement full-stack observability for service mesh deployments with metrics, traces, and logs.

Community
Advanced
elasticelastic
31

observability-edot-python-instrument

Automates EDOT telemetry instrumentation for Python services via zero-code changes.

Official
Intermediate