Skip to content

Document run and audit allowance behavior #736

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
SiddarthAA wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document run and audit allowance behavior #736

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions docs/agenteye/audits.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,6 +46,13 @@ Fixing an issue is only half the win. The other half is making sure it cannot qu

Audits live in the dashboard at **`/<org-slug>/audits`** (sidebar to *analyze* to *audits*). Viewing runs and findings needs **`audits:read`**; creating, editing, and triaging audits needs **`audits:write`**. Set an audit's scope and cadence, then hit **Run now** whenever you want results immediately instead of waiting for the next scheduled pass.

<Info>
Audit allowances are independent from run allowances. Reaching an audit
allowance skips new scheduled and manual audit runs without affecting event
ingestion. An administrator can reset or increase the allowance. Contact
[nikita@exosphere.host](mailto:nikita@exosphere.host) if you need help.
</Info>

## Related

- [Alerts](/agenteye/alerts): get paged the moment a threshold you already know about is crossed.
Expand Down
9 changes: 9 additions & 0 deletions docs/agenteye/sessions.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,15 @@ Each row carries a status pill, so a failed run stands out from a healthy one be

Once you connect an evaluator, every completed run is scored automatically and its latest score shows up on the row as a badge. You can filter by any score range, so "show me every low-scoring prod run this week" is a filter, not a manual review. Until you set one up, sessions still capture the full run; they just don't carry a score yet.

<Info>
Plans can include a run allowance. A run counts when its first valid event is
accepted. If your organization reaches its allowance, new runs remain safely
retained but do not appear in Sessions or trigger dependent processing until
an administrator increases or resets the allowance. Existing visible runs
stay available. Contact [nikita@exosphere.host](mailto:nikita@exosphere.host)
if you need a quota change.
</Info>

---

## Read the whole run as a picture
Expand Down