Skip to content

docs: clarify instrument.cjs is created in the user's own app #15

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

Merged
sagnik11 merged 2 commits into from
Aug 18, 2026
Merged

docs: clarify instrument.cjs is created in the user's own app #15

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9052d43
docs: clarify instrument.cjs is created in the user's own app
sagnik11 Aug 17, 2026
91713cd
Merge branch 'main' into posthog/docs-instrument-cjs-placement
sagnik11 Aug 18, 2026
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
3 changes: 2 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,8 @@
trackEvent("clicked_upgrade");
```

**Backend** — one preloaded file, requests traced automatically:
**Backend** — one preloaded file, created in your own app next to its entry

Check warning on line 57 in README.md

View check run for this annotation

Autter.dev / autter/review-gate

🟠 Medium · Missing linked tracker issue 

The PR description explicitly states that no linked tracker issue was identified. This change affects the README backend quickstart and the corresponding setup guidance in docs/GETTING-STARTED.md, so its documentation intent is not traceable to tracked work. Blast radius — skipping this guardrail cascades to the downstream usage that depends on this file: dependent files `@autter/runtime-browser`, `@autter/runtime-node`.
Suggested fix:
Add a tracker reference to the PR description, such as a GitHub issue number or Jira/Linear key, describing the clarification to the instrument.cjs setup instructions. Blast radius — skipping this guardrail cascades to the downstream usage that depends on this file: dependent files `@autter/runtime-browser`, `@autter/runtime-node`.
point, requests traced automatically:

```js
// instrument.cjs — run with: node --require ./instrument.cjs server.js
Expand Down
6 changes: 4 additions & 2 deletions docs/GETTING-STARTED.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,8 +90,10 @@
npm install @autter/runtime-node
```

Create `instrument.cjs` in your app's root, next to its entry point — it
must load **before** your app:
In **your application's repository** — a separate codebase from the

Check warning on line 93 in docs/GETTING-STARTED.md

View check run for this annotation

Autter.dev / autter/review-gate

🟠 Medium · Missing linked tracker issue 

This PR's title and body do not reference any tracker issue (GitHub `#123`, Jira/Linear `KEY-123`, or `Fixes/Closes/Resolves`).
Suggested fix:
In the PR description, add a reference to the tracker issue this change implements (GitHub `#123`, Jira/Linear `PROJ-456`, or a `Fixes/Closes/Resolves` marker). Reviewers anchor on `docs/GETTING-STARTED.md` around line 93 need that context to understand why this change exists and what success looks like. Why it matters: reviewers and on-call engineers need the linked issue to understand the why behind a change months from now.

Check warning on line 93 in docs/GETTING-STARTED.md

View check run for this annotation

Autter.dev / autter/review-gate

🟠 Medium · Missing CODEOWNERS reviewer approval 

docs/GETTING-STARTED.md has no approving review from a matching CODEOWNERS owner; the supplied CODEOWNERS file is empty and all listed reviews are comments or change requests. This leaves the getting-started instrumentation instructions without required ownership approval. Blast radius — skipping this guardrail cascades to the downstream usage that depends on this file: dependent files `@autter/runtime-browser`, `@autter/runtime-node`.
Suggested fix:
Add the appropriate documentation owner to CODEOWNERS or configure the applicable owner, then obtain an approving review from that owner for docs/GETTING-STARTED.md. Blast radius — skipping this guardrail cascades to the downstream usage that depends on this file: dependent files `@autter/runtime-browser`, `@autter/runtime-node`.
`autter-runtime` repo you cloned in step 2 — create `instrument.cjs` next to
the entry point of the service you are instrumenting (one file per service in
a monorepo). It must load **before** your app:

```js
const { initAutterServer } = require("@autter/runtime-node");
Expand Down
Loading