CLI: analytics

farthershore analytics#

Usage: farthershore analytics [options] [command]

Query the business event archive

Options:
  -h, --help                               display help for command

Commands:
  timeseries [options] [businessIdOrName]  Request (or denial) volume over time
  latency [options] [businessIdOrName]     Request latency percentiles (p50 / p95 / p99)
  top [options] [businessIdOrName]         Top callers / event types / environments by volume
  log [options] [businessIdOrName]         Recent requests — the live metering signal, newest first
  help [command]                           display help for command

farthershore analytics timeseries#

Usage: farthershore analytics timeseries [options] [businessIdOrName]

Request (or denial) volume over time

Options:
  --range <range>        Relative window: 1h | 24h | 7d | 30d (default: "24h")
  --env <environmentId>  Environment id to scope to. Omit for production — never
                         for 'all environments'.
  --domain <domain>      Archive domain: usage | telemetry | denials | lifecycle
                         | consumer_activity | audit (default: "usage")
  --interval <interval>  Bucket size: hour | day (default: "hour")
  -h, --help             display help for command

farthershore analytics latency#

Usage: farthershore analytics latency [options] [businessIdOrName]

Request latency percentiles (p50 / p95 / p99)

Options:
  --range <range>        Relative window: 1h | 24h | 7d | 30d (default: "24h")
  --env <environmentId>  Environment id to scope to. Omit for production — never
                         for 'all environments'.
  -h, --help             display help for command

farthershore analytics top#

Usage: farthershore analytics top [options] [businessIdOrName]

Top callers / event types / environments by volume

Options:
  --range <range>        Relative window: 1h | 24h | 7d | 30d (default: "24h")
  --env <environmentId>  Environment id to scope to. Omit for production — never
                         for 'all environments'.
  --by <dimension>       Break down by: actor_id | type | environment_id
                         (default: "actor_id")
  --domain <domain>      Archive domain: usage | telemetry | denials | lifecycle
                         | consumer_activity | audit (default: "usage")
  --k <count>            How many rows (1-50) (default: "10")
  -h, --help             display help for command

farthershore analytics log#

Usage: farthershore analytics log [options] [businessIdOrName]

Recent requests — the live metering signal, newest first

Options:
  --range <range>        Relative window: 1h | 24h | 7d | 30d (default: "24h")
  --env <environmentId>  Environment id to scope to. Omit for production — never
                         for 'all environments'.
  --domain <domain>      Archive domain: usage | telemetry | denials | lifecycle
                         | consumer_activity | audit (default: "usage")
  --limit <count>        How many rows (1-100) (default: "25")
  -h, --help             display help for command