Skip to content

Commit b9b6bc0

Browse files
authored
Expand README for src/audit-logs (#58901)
1 parent 635784d commit b9b6bc0

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

src/audit-logs/README.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,3 +69,26 @@ Slack: `#docs-engineering`
6969
Repo: `github/docs-engineering`
7070

7171
If you have a question about the audit log events pipeline, you can ask in the `#docs-engineering` Slack channel. If you notice a problem with the audit log events pipeline, you can open an issue in the `github/docs-engineering` repository.
72+
73+
## Ownership & On-call
74+
75+
### Ownership
76+
- **Team**: Docs Engineering
77+
- **Source data**: github/audit-log-allowlists
78+
79+
### On-call procedures
80+
If the audit log pipeline fails:
81+
1. Check workflow logs in `.github/workflows/sync-audit-logs.yml`
82+
2. Verify access to `github/audit-log-allowlists` repo
83+
3. Check for schema changes in source data
84+
4. Escalate to #docs-engineering if stuck
85+
86+
### Monitoring
87+
- Daily workflow runs automatically
88+
- PRs created with `audit-log-pipeline` label when updates detected
89+
- Failures visible in GitHub Actions
90+
91+
We are not expecting significant investment here. We will support updates to audit log data as we receive them.
92+
- Automate version detection
93+
- Add event usage analytics
94+
- Create event category visualizations

0 commit comments

Comments
 (0)