Sentry CLI - nself-org/plugins GitHub Wiki

Sentry-CLI Plugin

Field Value
Licence Free (MIT)
Maturity implemented (maturity levels)
Version 1.2.6
Install nself plugin install sentry-cli
Commands nself sentry: alerts channels, alerts test, incidents ack, incidents list, incidents resolve, login, logout, monitors add, monitors list, monitors pause, monitors resume, monitors rm, status, status-pages create, status-pages list, whoami
Requirements nSelf >=1.2.8

Operates a self-hosted ɳSentry instance: monitors, incidents, status pages, and alerts.

Install

nself plugin install sentry-cli

No license key required.

Description

ɳSentry operations: monitors, incidents, status pages, alerts, cloud login, and provisioning a self-hosted sentry server.

This is a CLI plugin: it installs the nself-sentry-cli binary into your plugin path and runs as a command, not a background service.

Category: infrastructure. Current version: 1.0.0.

Configuration

Env Var Default Description
HETZNER_NSELF_TOKEN — Optional.
HCLOUD_TOKEN — Optional.

Commands

nself-sentry-cli subcommands (installed alongside the plugin):

  • nself-sentry-cli login
  • nself-sentry-cli logout
  • nself-sentry-cli whoami
  • nself-sentry-cli monitors
  • nself-sentry-cli incidents
  • nself-sentry-cli alerts
  • nself-sentry-cli channels
  • nself-sentry-cli status-pages
  • nself-sentry-cli status
  • nself-sentry-cli provision <project>
  • nself-sentry-cli sentry-server

Examples

Login

nself-sentry-cli login

Logout

nself-sentry-cli logout

JSON output

Every nself sentry subcommand accepts --json. The shape depends on the compat mode (NSELF_V15=1 selects v1.5):

  • v1.5: one v1 envelope on stdout (schema_version, command, then data or error) and nothing else on stdout. Progress and human text go to stderr. A failure prints the error envelope and exits with the status of its class: user 1, infra 2, auth 3.
  • v1.4 (default): the commands that printed JSON before keep those bytes exactly (the bare payload, written by cobra to stderr as before; status writes its summary to stdout). login, logout and sentry-server provision printed no JSON before, so they print the envelope in both modes.
Command v1.5 data v1.4 --json
monitors list {"monitors": [...]} bare array
monitors add, pause, resume {"monitor": {...}} bare monitor
monitors rm {"deleted": "<id>"} {"deleted": "<id>"}
incidents list {"incidents": [...]} bare array
incidents ack, resolve {"incident": {...}} bare incident
status-pages list {"status_pages": [...]} bare array
status-pages create {"status_page": {...}} bare page
alerts channels {"channels": [...]} bare array
alerts test {"delivered", "detail"}; a failed delivery is an error envelope (E784) same object, exit 0
whoami the account object the account object
status {"overall", "total", "operational", "degraded", "down", "components"}; exit 1 when not operational, as before same object
login {"logged_in", "email", "tenant_id", "tier"} same (envelope)
logout {"logged_out": true} same (envelope)
sentry-server provision {"project", "dry_run", "terraform", "deployed"} same (envelope)

Error codes: E401 usage, E780 API key missing or rejected (auth), E781 plan quota exceeded, E782 API request failed, E783 status page fetch failed, E784 test notification not delivered, E785 credentials file error, E786 provision step failed, E789 unexpected. Error text is fixed: it never carries an API key, a URL or the upstream error body.

Source

plugins/sentry-cli/

Manifest: plugins/sentry-cli/plugin.json

See Also

  • Watchdog — self-healing container watchdog
  • Alerts — Prometheus alert rules and silences

← Home →

⚠️ **GitHub.com Fallback** ⚠️