observability-report

Analyze Shannon log files for session traces, health checks, and audits.

2|Updated Jul 13, 2025
One-click install
npx skills add https://github.com/krzemienski/shannon --skill observability-report
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: observability-report
Source: https://github.com/krzemienski/shannon/tree/main/skills/observability-report
Command: npx skills add https://github.com/krzemienski/shannon --skill observability-report

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill requires python-agent-sdk, and includes scripts (resource) and references (resource) components.

What problem does it solve?

This Skill provides deep diagnostic insights into Shannon's log files, enabling users to trace sessions, diagnose issues, and audit logs.

Core Features & Use Cases

  • Session Tracing: Offers a detailed post-hoc timeline of session events.
  • Health Check: Performs a comprehensive check on the plugin's configuration and recent activity.
  • Live Run State: Monitors and displays the current state of active runs and recent activities.
  • Session Log Audit: Aggregates session logs and optionally correlates with git history.
  • Use Case: When a user wants to investigate why a particular session failed, they can use the observability-report Skill to trace the timeline, check the health, and audit the session logs.

Quick Start

To trace the session with ID "session123", run: /shannon:trace "session123"

Frequently Asked Questions about observability-report

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

FAQPage Schema
How do I analyze Shannon log files to trace why a session failed?

Session tracing analyzes Shannon log files to provide a detailed post-hoc timeline of session events, helping you investigate why a particular session failed. You can execute a trace command using the specific session ID.

Can I export Shannon system diagnostics to Prometheus or OTLP formats?

Yes, you can export Shannon system diagnostics to Prometheus and OTLP formats. This allows you to integrate health checks and live run state monitoring data directly into your existing observability platforms.

Do I need python-agent-sdk to run health checks and monitor live run state?

Yes, the python-agent-sdk dependency is required to run health checks and monitor live run state. It provides the necessary framework for cross-referencing hook events during session log analysis.

What is the best way to audit session logs and correlate them with git history?

The best way to audit session logs is to aggregate the logs and optionally correlate them with git history. This diagnostic approach provides a comprehensive view of session activities directly alongside relevant code changes.

How does session tracing work for post-hoc timeline analysis in Shannon?

Session tracing works by analyzing Shannon log files to construct a detailed post-hoc timeline of session events. It cross-references hook events using the python-agent-sdk to accurately map the complete execution flow.