Skip to content

Point the usage-reporting link at a public page #8

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
dmccoystephenson merged 1 commit into from
Oct 6, 2026
Merged

Point the usage-reporting link at a public page #8

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
10 changes: 10 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ All notable changes to this project are recorded here. The version in the
header comment of `trace-client.ts` is the one consumers vendor; check it
against this file to see what a re-vendor would bring.

## [Unreleased]

- The usage-reporting details link in the `TraceClient` doc comment and the
README's startup-notice example now points at
https://danielstephenson.dev/usage-reporting. The old link pointed into a
private repository, so anyone following it got a 404. Programs that copied
the README example should update the URL in their own notice.
- The README's Keys section no longer links to a decision record in that
private repository.

## 0.4.0 — 2026-10-03

A random per-installation ID, matching trace-client-java 0.5.0, so the
Expand Down
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ this order — so a program can say so in its startup notice:

```ts
console.log(trace.enabled
? "Usage reporting is on. Details: https://github.com/Stephenson-Software/trace#usage-reporting"
? "Usage reporting is on. Details: https://danielstephenson.dev/usage-reporting"
: `Usage reporting is off (${trace.disabledReason}).`);
```

Expand Down Expand Up @@ -287,10 +287,8 @@ tolerated.
A key identifies the program to the server and lets the operator revoke it;
it is scoped to *reporting only*. Because it ships inside the program — in a
public repository, in a browser-adjacent runtime — it cannot prove anything;
treat trace data as best-effort telemetry, which is what it is. The reasoning
is written up in the trace repository's
[decision record on per-program write keys](https://github.com/Stephenson-Software/trace/blob/main/docs/decisions/0001-per-program-write-keys.md).
Ask the trace operator for a key for your program.
treat trace data as best-effort telemetry, which is what it is. Ask the
trace operator for a key for your program.

## Building

Expand Down
2 changes: 1 addition & 1 deletion trace-client.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ export interface ReportOptions {
* `"config"` or `"no key"`; `null` when on) so the program can say so in its
* notice. Programs that run on other people's machines should expose that
* switch in their settings and say so once, pointing at
* https://github.com/Stephenson-Software/trace#usage-reporting.
* https://danielstephenson.dev/usage-reporting.
*
* Every event carries the program's own version as the tag `version` -- the
* required `version` option -- so a `page-view` or `command` event can be
Expand Down
Loading