suzieq-observability

Query and analyze current and historical network state with SuzieQ observability tools.

Updated Feb 28, 2026
One-click install
npx skills add https://github.com/dgethings/netclaw --skill suzieq-observability
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: suzieq-observability
Source: https://github.com/dgethings/netclaw/tree/main/workspace/skills/suzieq-observability
Command: npx skills add https://github.com/dgethings/netclaw --skill suzieq-observability

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

SuzieQ network observability enables you to query current and historical network state, validate conditions, summarize data, trace forwarding paths, and discover unique values across 20+ network tables, helping diagnose connectivity issues and verify network health.

Core Features & Use Cases

  • suzieq_show: Query detailed network state data from any SuzieQ table. Supports filtering by device, namespace, time range, and columns; suitable for current and historical analysis.
  • suzieq_summarize: Get aggregated statistics and summary views of any SuzieQ network table, returning counts, distributions, and per-device breakdowns.
  • suzieq_assert: Run validation assertions against network state to ensure health (e.g., BGP established, interfaces up) and policy compliance.
  • suzieq_unique: Get distinct values and counts for a specific column in a SuzieQ table to understand value distributions.
  • suzieq_path: Trace the forwarding path between two endpoints to troubleshoot connectivity.

Quick Start

Start by issuing a sample suzieq_show query to validate current state and build a baseline.

Frequently Asked Questions about suzieq-observability

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

FAQPage Schema
How do I trace a forwarding path between two endpoints to troubleshoot connectivity?

To trace a forwarding path, use the suzieq_path function to trace the network route between two endpoints, returning the hop-by-hop path to diagnose connectivity issues.

How do I validate BGP and OSPF network health and policy compliance?

You can validate BGP and OSPF health by running suzieq_assert validation assertions against network state to ensure protocols like BGP are established and interfaces are up.

Can I query historical network state data for time-travel analysis?

Yes, you can query historical network state using suzieq_show, which supports filtering by device, namespace, and time range across 20+ network tables for time-travel analysis.

Do I need a SuzieQ API URL and API key to query network state?

Yes, you must configure the SUZIEQ_API_URL and SUZIEQ_API_KEY environment variables to connect the Python-based server to your SuzieQ instance for querying network state.

What is the best way to get aggregated statistics and summary views for network interfaces?

The best way to get aggregated statistics is using suzieq_summarize, which returns counts, distributions, and per-device breakdowns for any SuzieQ network table like interfaces or EVPN.