mirror of
https://github.com/paperclipai/paperclip.git
synced 2026-11-16 11:59:26 +01:00
## Thinking Path > - Paperclip is the open source app people use to manage AI agents for work > - `doc/observability.md` and `doc/run-log-events.md` described every OpenTelemetry span and every run-log event > - `rules/data-paths.mdc` told authors to update `doc/run-log-events.md` for each event, so both files only grew: 2,313 and 1,263 lines > - Each span and event is already defined next to the code that writes it, and its name is a literal string that a search finds in one step > - This pull request removes the per-span and per-event catalogs and keeps only what code does not say > - The benefit is two short docs that do not drift from the code, and no rule that makes them grow again ## Linked Issues or Issue Description Refs #21670, #21700, and #21743 (the same cleanup for other docs). **Issue type** Outdated or confusing documentation. **Where is the issue?** `doc/observability.md`, `doc/run-log-events.md`, and `rules/data-paths.mdc` **What's wrong?** The two docs repeated span names, span attributes, and event payloads that the code defines. Operator setup started at line 138 of `doc/observability.md`. The rule required a doc edit for every new run-log event. **Suggested fix** Keep operator setup and the Sentry privacy contract. Point to the code for span and event definitions. Remove the rule line that requires a doc entry per event. ## What Changed - `doc/observability.md` is now 619 lines. It keeps: how to enable tracing, `service.version` resolution, scope, how to enable Sentry, DSN delivery, environment attribution, privacy settings, server request data, the core of "Run failure context", browser data, fail-open behavior, the default capture set, and operator responsibilities. Kept text is unchanged except the intro and two sentences noted below. - Deleted from `doc/observability.md`: budget, Slack receipt, task detail, and browser tracing notes; controller preparation phases; native Runner spans; sandbox startup spans; sandbox duplex transport; shared skill preparation; invocation attribution; and about 500 lines of per-failure detail in "Run failure context". - Replaced that per-failure detail with one paragraph. It names the failures that `unexpected` mode keeps out of Sentry, and says the remaining diagnostic contexts are defined in `server/src/sentry.ts`. "Default capture set" now says the same. - `doc/run-log-events.md` is now 23 lines. It says what the run log is, where events are defined and appended, and keeps the payload storage note. - `rules/data-paths.mdc`: the run-log line now says to define an event where it is written, not in a doc. The span-allowlist line now says the allowlist is in the code that opens the span. The review levels and globs do not change. - Repointed links in two feature maps, two agent-access map files, `tests/runner-e2e/SUITES.md`, `doc/runner-api-tools.md`, and the Telemetry README. Updated the `honeycomb-tracing` skill and one code comment in `packages/adapter-utils/src/http2-bridge-server.ts`. ## Verification - A script built the new `doc/observability.md` from line ranges of the old file and asserts the first line of each range. - A link check on all changed Markdown files found 0 missing files and 0 missing anchors. The remaining inbound anchors (`#enabling-tracing`, `#sentry-error-monitoring`) still exist. - No test reads either doc. - `node scripts/check-maps.mjs` passes. - `node --test .github/scripts/tests/*.test.mjs`: 808 pass, 0 fail. - `pnpm verify` was not run. This worktree has no installed dependencies. The only code change is a comment. ## Risks - The privacy contract no longer lists each run-failure diagnostic context field. `server/src/sentry.ts` is now the list. A reviewer of a Sentry change must read that file. - No browsable list of span names or run-log event names remains. A search for the quoted name finds the producer. - `.greptile/files.json` still scopes `rules/data-paths.mdc` to both docs. Both files still exist, so it does not change. ## Model Used - Claude Opus 5.5 (`claude-opus-5-5`), Claude Code desktop, with tool use. Earlier analysis in this session used Claude Fable 5.2. ## Checklist - [x] I have included a thinking path that traces from project context to this change - [x] I have specified the model used (with version and capability details) - [x] I have checked ROADMAP.md and confirmed this PR does not duplicate planned core work - [x] I have searched GitHub for duplicate or related PRs and linked them above - [x] I have either (a) linked existing issues with `Fixes: #` / `Closes #` / `Refs #` OR (b) described the issue in-PR following the relevant issue template - [x] I have not referenced internal/instance-local Paperclip issues or links (only public GitHub `#NNN` / `github.com/paperclipai/paperclip` URLs) - [x] My branch name describes the change (e.g. `docs/...`, `fix/...`) and contains no internal Paperclip ticket id or instance-derived details - [x] I have run tests locally and they pass - [ ] I have added or updated tests where applicable - [x] I have updated relevant documentation to reflect my changes - [x] I have considered and documented any risks above - [ ] All Paperclip CI gates are green - [ ] Greptile is 5/5 with no open P2s, recommendations, or follow-ups - [x] I will address all Greptile and reviewer comments before requesting merge 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
71 lines
3.5 KiB
Plaintext
71 lines
3.5 KiB
Plaintext
---
|
|
description: Keep Telemetry, Observability, and the run log distinct, and apply the review level that matches the path a change touches.
|
|
globs: "packages/shared/src/telemetry/**,server/src/instrumentation.ts,doc/observability.md,packages/adapter-utils/src/duplex-observability.ts,server/src/services/duplex-observability-recorder.ts,packages/adapter-utils/src/acpx-engine/startup-timing.ts,doc/run-log-events.md,packages/db/src/schema/heartbeat_run_events.ts,server/src/services/heartbeat.ts"
|
|
alwaysApply: false
|
|
---
|
|
|
|
# Three data paths
|
|
|
|
## Scope and purpose
|
|
|
|
This repo has three separate data paths. Do not confuse them. Match a change to
|
|
a path by its file path, not by the word "observability" or "telemetry" alone.
|
|
|
|
This rule also applies to any file that adds or changes a caller of
|
|
`packages/shared/src/telemetry/events.ts` or
|
|
`packages/shared/src/telemetry/client.ts`, even when that file is outside the
|
|
globs above.
|
|
|
|
## The paths
|
|
|
|
- **Telemetry** is the Paperclip first-party event system. It is opt-out and it
|
|
sends data to a Paperclip endpoint by default. Its paths are:
|
|
- `packages/shared/src/telemetry/`
|
|
- the generated contract `packages/shared/src/telemetry/generated/paperclip-telemetry.ts`
|
|
- each caller of `packages/shared/src/telemetry/events.ts` or `packages/shared/src/telemetry/client.ts`
|
|
- **Observability** is the OpenTelemetry trace path. An operator must set an
|
|
OTLP endpoint. Until an operator sets the endpoint, the tracer is a
|
|
no-operation. Its paths are:
|
|
- `server/src/instrumentation.ts`
|
|
- `doc/observability.md`
|
|
- `packages/adapter-utils/src/duplex-observability.ts`
|
|
- `server/src/services/duplex-observability-recorder.ts`
|
|
- the span attributes in `packages/adapter-utils/src/acpx-engine/startup-timing.ts`
|
|
- **The run log** holds rows in the local `heartbeat_run_events` table. The data
|
|
stays in the instance database. Its paths are:
|
|
- `doc/run-log-events.md`
|
|
- `packages/db/src/schema/heartbeat_run_events.ts`
|
|
- the append path `appendRunEvent` in `server/src/services/heartbeat.ts`
|
|
|
|
## Requirements
|
|
|
|
Apply a review level that matches the path:
|
|
|
|
- **Telemetry change (strict review).** The author updates the generated
|
|
contract first. The author updates `packages/shared/src/telemetry/README.md`
|
|
in the same pull request. The author requests a privacy review. Reason: a
|
|
Telemetry event goes to a Paperclip endpoint by default, so a mistake sends
|
|
data immediately.
|
|
- **Observability change (lighter review).** The operator endpoint gate stays in
|
|
place. The no-operation behaviour stays when no endpoint is set. A privacy
|
|
review is not necessary while the change stays inside the closed
|
|
span-attribute allowlist defined in the code that opens the span.
|
|
- **Run-log change (no extra review).** A run-log change needs neither review
|
|
level above, because the data stays in the instance database. Define the
|
|
event and its payload where it is written; do not list it in a doc.
|
|
|
|
## Exclusion
|
|
|
|
The word "observability" in a file such as
|
|
`server/src/services/recovery-observability.ts` names a different concept. Apply
|
|
this rule by path, not by word match.
|
|
|
|
## Review criteria
|
|
|
|
Identify which path each changed file belongs to. Flag a Telemetry change that
|
|
lacks the generated-contract update, the README update, or a privacy review
|
|
request. Flag an Observability change that emits without the operator endpoint
|
|
or adds a span attribute outside the allowlist. Flag data described as
|
|
"telemetry" or "observability" that is actually written to a different path. Do
|
|
not request a privacy review for a run-log-only change.
|