cayu diagnostics

Generated from the released command parser. These commands show help only; operations run when you invoke the command without --help.

usage: cayu diagnostics [-h] {requests} ...

Read live diagnostics from a running Cayu server.

positional arguments:
  {requests}
    requests  Summarize recent request rate, latency, and CPU by route.

options:
  -h, --help  show this help message and exit

cayu diagnostics requests

usage: cayu diagnostics requests [-h] [--server-url SERVER_URL]
                                 [--since DURATION] [--vcpu VCPU]
                                 [--budget-idle-cpu FRACTION] [--top TOP]
                                 [--authorization-env NAME]
                                 [--format {json,table} | --json | --table]
                                 [--output FILE]

Summarize the server's in-memory request-timing buffer: requests per minute,
wall time, and CPU seconds per minute by route template, the top routes by
CPU, and the estimated share of --vcpu CPUs. With --budget-idle-cpu the
command exits 1 when that share exceeds the budget; it exits 2 when the
summary cannot be read. Authorization is read from CAYU_API_AUTHORIZATION by
default and is never printed.

options:
  -h, --help            show this help message and exit
  --server-url SERVER_URL
                        Cayu server root URL, including any mount prefix but
                        excluding /api (default: http://127.0.0.1:8000; use
                        http://127.0.0.1:8000/cayu for an app that calls
                        mount_cayu at /cayu).
  --since DURATION      Window to summarize, such as 90s, 5m, or 1h (default:
                        5m).
  --vcpu VCPU           CPUs available to the web process, used for the share
                        (default: 1).
  --budget-idle-cpu FRACTION
                        Exit 1 when request CPU exceeds this fraction of
                        --vcpu, for example 0.01 for 1%.
  --top TOP             Number of routes to show in table output (default:
                        10).
  --authorization-env NAME
                        Environment variable containing the complete
                        Authorization header value.
  --format {json,table}
                        Output format (default: table).
  --json                Emit JSON (shorthand for `--format json`).
  --table               Emit human-readable output (shorthand for `--format
                        table`).
  --output, -o FILE     Write output to FILE instead of stdout.

Getting started · Operations · Configuration