Debug CLI

graphsignal-debug

CLI for logging in and fetching Graphsignal debug context.

Install:

pip install graphsignal-debug

Or install as an isolated CLI tool with uv:

uv tool install graphsignal-debug

graphsignal-debug login

Store your Graphsignal API key in ~/.graphsignal/config.yml.

graphsignal-debug login

You will be prompted for your API key.

graphsignal-debug fetch

Fetch debug context for a time range.

graphsignal-debug fetch --start 2026-03-10T00:00:00Z --end 2026-03-12T00:00:00Z

Optional --tags filter:

graphsignal-debug fetch \
  --start 2026-03-10T00:00:00Z \
  --end 2026-03-12T00:00:00Z \
  --tags "env:prod;service:inference"

Options:

  • --start (required): Start of time range in ISO 8601 format (for example, 2026-03-10T00:00:00Z).
  • --end (required): End of time range in ISO 8601 format.
  • --tags (optional): Semicolon-separated key:value pairs for exact tag filtering.

Behavior:

  • Requires a saved API key (graphsignal-debug login).
  • Converts --start and --end into nanosecond timestamps.
  • Calls GET /api/v1/debug_context/ on https://api.graphsignal.com.
  • Prints the returned context payload to stdout.

Common errors:

  • Not logged in: run graphsignal-debug login.
  • Invalid datetime format for --start or --end.
  • --start must be before --end.
  • API request errors (for example, invalid API key).