home / skills / derklinke / codex-config / sentry

sentry skill

/skills/sentry

This skill inspects Sentry issues and events, summarizes recent errors, and retrieves health data via the API using a read-only token.

This is most likely a fork of the sentry skill from openai
npx playbooks add skill derklinke/codex-config --skill sentry

Review the files below or copy the command above to add this skill to your agents.

Files (6)
SKILL.md
3.7 KB
---
name: "sentry"
description: "Use when the user asks to inspect Sentry issues or events, summarize recent production errors, or pull basic Sentry health data via the Sentry API; perform read-only queries with the bundled script and require `SENTRY_AUTH_TOKEN`."
---


# Sentry (Read-only Observability)

## Quick start

- If not already authenticated, ask the user to provide a valid `SENTRY_AUTH_TOKEN` (read-only scopes such as `project:read`, `event:read`) or to log in and create one before running commands.
- Set `SENTRY_AUTH_TOKEN` as an env var.
- Optional defaults: `SENTRY_ORG`, `SENTRY_PROJECT`, `SENTRY_BASE_URL`.
- Defaults: org/project `{your-org}`/`{your-project}`, time range `24h`, environment `prod`, limit 20 (max 50).
- Always call the Sentry API (no heuristics, no caching).

If the token is missing, give the user these steps:
1. Create a Sentry auth token: https://sentry.io/settings/account/api/auth-tokens/
2. Create a token with read-only scopes such as `project:read`, `event:read`, and `org:read`.
3. Set `SENTRY_AUTH_TOKEN` as an environment variable in their system.
4. Offer to guide them through setting the environment variable for their OS/shell if needed.
- Never ask the user to paste the full token in chat. Ask them to set it locally and confirm when ready.

## Core tasks (use bundled script)

Use `scripts/sentry_api.py` for deterministic API calls. It handles pagination and retries once on transient errors.

## Skill path (set once)

```bash
export CODEX_HOME="${CODEX_HOME:-$HOME/.codex}"
export SENTRY_API="$CODEX_HOME/skills/sentry/scripts/sentry_api.py"
```

User-scoped skills install under `$CODEX_HOME/skills` (default: `~/.codex/skills`).

### 1) List issues (ordered by most recent)

```bash
python3 "$SENTRY_API" \
  list-issues \
  --org {your-org} \
  --project {your-project} \
  --environment prod \
  --time-range 24h \
  --limit 20 \
  --query "is:unresolved"
```

### 2) Resolve an issue short ID to issue ID

```bash
python3 "$SENTRY_API" \
  list-issues \
  --org {your-org} \
  --project {your-project} \
  --query "ABC-123" \
  --limit 1
```

Use the returned `id` for issue detail or events.

### 3) Issue detail

```bash
python3 "$SENTRY_API" \
  issue-detail \
  1234567890
```

### 4) Issue events

```bash
python3 "$SENTRY_API" \
  issue-events \
  1234567890 \
  --limit 20
```

### 5) Event detail (no stack traces by default)

```bash
python3 "$SENTRY_API" \
  event-detail \
  --org {your-org} \
  --project {your-project} \
  abcdef1234567890
```

## API requirements

Always use these endpoints (GET only):

- List issues: `/api/0/projects/{org_slug}/{project_slug}/issues/`
- Issue detail: `/api/0/issues/{issue_id}/`
- Events for issue: `/api/0/issues/{issue_id}/events/`
- Event detail: `/api/0/projects/{org_slug}/{project_slug}/events/{event_id}/`

## Inputs and defaults

- `org_slug`, `project_slug`: default to `{your-org}`/`{your-project}` (avoid non-prod orgs).
- `time_range`: default `24h` (pass as `statsPeriod`).
- `environment`: default `prod`.
- `limit`: default 20, max 50 (paginate until limit reached).
- `search_query`: optional `query` parameter.
- `issue_short_id`: resolve via list-issues query first.

## Output formatting rules

- Issue list: show title, short_id, status, first_seen, last_seen, count, environments, top_tags; order by most recent.
- Event detail: include culprit, timestamp, environment, release, url.
- If no results, state explicitly.
- Redact PII in output (emails, IPs). Do not print raw stack traces.
- Never echo auth tokens.

## Golden test inputs

- Org: `{your-org}`
- Project: `{your-project}`
- Issue short ID: `{ABC-123}`

Example prompt: “List the top 10 open issues for prod in the last 24h.”
Expected: ordered list with titles, short IDs, counts, last seen.

Overview

This skill inspects Sentry issues and events via the Sentry API to provide read-only observability data for production. It uses a bundled Python script to run deterministic API calls, handle pagination and retries, and returns formatted summaries of issues, events, and basic health metrics. A valid SENTRY_AUTH_TOKEN with read-only scopes is required and must be set as an environment variable before use.

How this skill works

The skill calls a local helper script (scripts/sentry_api.py) which performs GET requests against the Sentry API endpoints for issues, issue detail, issue events, and event detail. It accepts org, project, time range, environment, limit, and query inputs, paginates until the requested limit or API end, and retries once on transient errors. All output is redacted for PII and never includes raw stack traces or auth tokens.

When to use it

  • Summarize recent production errors for the last 24 hours.
  • List unresolved or high-frequency issues in a project.
  • Fetch details for a specific issue or event ID.
  • Inspect recent events for root cause hints without exposing stack traces.
  • Pull basic Sentry health or volume metrics for on-call triage.

Best practices

  • Require the user to set SENTRY_AUTH_TOKEN as an environment variable; do not accept token pasted in chat.
  • Default to org/project {your-org}/{your-project}, environment prod, time range 24h, limit 20 (max 50).
  • Always call the API—do not cache or infer results from local heuristics.
  • Redact emails, IPs, and other PII; do not print raw stack traces.
  • Use the bundled script path set via SENTRY_API and export CODEX_HOME once per environment.

Example use cases

  • List the top 10 open issues in prod for the last 24h, ordered by most recent.
  • Resolve a short issue ID (ABC-123) to the internal issue id and fetch issue detail.
  • Fetch the last 20 events for a given issue id to surface culprits and timestamps.
  • Retrieve event detail (no raw stack traces) including culprit, release, environment, timestamp, and URL.
  • Check issue counts and top tags for quick triage during an incident call.

FAQ

What auth scopes are required?

Use a token with read-only scopes such as project:read, event:read, and org:read.

How do I provide the token?

Set SENTRY_AUTH_TOKEN as an environment variable on your machine. I can guide you through the export command for your OS/shell, but do not paste the token here.

What if no results are returned?

The skill will state explicitly when there are no results for the given filters and suggest broadening time range or removing query filters.