Skip to content

Commit

Permalink
changeset + update telemetry docs
Browse files Browse the repository at this point in the history
  • Loading branch information
emily-shen committed Jan 27, 2025
1 parent 5a04c25 commit b2a88e1
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 1 deletion.
7 changes: 7 additions & 0 deletions .changeset/old-teachers-bow.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
---
"wrangler": minor
---

feat: add sanitised error messages to Wrangler telemetry

Error messages that have been audited for potential inclusion of personal information, and explicitly opted-in, are now included in Wrangler's telemetry collection. Collected error messages will not include any filepaths, user input or any other potentially private content.
3 changes: 3 additions & 0 deletions packages/wrangler/src/metrics/types.ts
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,9 @@ export type Events =
* Type of error, e.g. UserError, APIError. Does not include stack trace or error message.
*/
errorType: string | undefined;
/**
* Sanitised error messages that will not include user information like filepaths or stack traces (e.g. `Asset too large`).
*/
errorMessage: string | undefined;
};
};
2 changes: 1 addition & 1 deletion packages/wrangler/telemetry.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ Telemetry in Wrangler allows us to better identify bugs and gain visibility on u
- The format of the Wrangler configuration file (e.g. `toml`, `jsonc`)
- Total session duration of the command run (e.g. 3 seconds, etc.)
- Whether the Wrangler client is running in CI or in an interactive instance
- Error _type_, if one occurs (e.g. `APIError` or `UserError`)
- Error _type_ (e.g. `APIError` or `UserError`), and sanitised error messages that will not include user information like filepaths or stack traces (e.g. `Asset too large`).
- General machine information such as OS and OS Version

Cloudflare will receive the IP address associated with your machine and such information is handled in accordance with Cloudflare’s [Privacy Policy](https://www.cloudflare.com/privacypolicy/).
Expand Down

0 comments on commit b2a88e1

Please sign in to comment.