skills.rest
bigeasyfreeman
bigeasyfreemanCOMMUNITY
Explore all skills by this author →
GitHub

observability-contract

Enforce structured error, audit, and general logging for tasks with observability requirements.

2|1|Updated Apr 7, 2026
Search Tags:#system monitoring#audit logging#error tracking#structured logging#correlation id
One-click install
npx skills add https://github.com/bigeasyfreeman/adlc --skill observability-contract
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: observability-contract
Source: https://github.com/bigeasyfreeman/adlc/tree/main/skills/observability-contract
Command: npx skills add https://github.com/bigeasyfreeman/adlc --skill observability-contract

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill ensures that all tasks with observability requirements are properly logged, aiding in error diagnosis, auditing, and system monitoring.

Core Features & Use Cases

  • Active Logging: Enforces structured logging for tasks that interact with runtime paths, service boundaries, or user-facing operations.
  • Phased Activation: Activates logging during critical phases like specification and verification.
  • Applicability Decision: Allows for decisions on whether logging is required based on the task's observability surface.
  • Three Log Types: Supports error logging, audit logging, and general logging with specific requirements for each.
  • Correlation IDs: Ensures proper propagation of correlation IDs for request tracing.
  • Pipeline Observability: Monitors pipeline runs with structured audit logs.
  • Verification: Conducts AST-based scans to verify the presence of logging where required.

Quick Start

Apply the observability-contract skill to a task to activate logging requirements based on the task's applicability.

Frequently Asked Questions about observability-contract

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

FAQPage Schema
How do I add structured logging for system monitoring and audit tracking?▼

Using structured logging for error tracking ensures proper error diagnosis and system monitoring. It enforces active logging requirements across runtime paths and service boundaries, capturing errors where they occur to aid in rapid diagnosis.

How do I ensure correlation IDs are propagated for request tracing?▼

An observability contract enforces audit logging by applying manifest-based decisions to pipeline runs. It monitors pipeline executions with structured audit logs, ensuring all service boundary interactions and critical phase activities are properly recorded.

Can I verify if logging is present where required without running the application?▼

You can decide if logging is required by evaluating the task's observability surface. An observability contract allows for applicability decisions, ensuring logging is only enforced on tasks interacting with runtime paths or user-facing operations.

What is the best way to enforce logging rules across pipeline runs?▼

The best way to enforce logging rules across pipeline runs is through pipeline-level audit logging. This monitors pipeline executions using structured logs and manifest-based decisions, ensuring comprehensive observability and audit tracking.

Related Skills

Explore More Software Engineering Skills→
TiepbmTiepbm

system-design

Create production system designs defining boundaries, components, and runtime flows.

Community
Advanced
fabioc-alohafabioc-aloha
1

Observability & Monitoring

Set up OpenTelemetry instrumentation for Node.js and .NET applications.

Community
Advanced
BarisSozenBarisSozen
1

error-logger

Generate structured JSON logs with correlation IDs for distributed services.

Community
Basic
majedsiefalnasrmajedsiefalnasr

observability-standards

Configure Laravel logging with correlation IDs and structured log formats.

Community
Intermediate