[wrangler]: add wrangler telemetry commands and update existing info on telemetry collection
#18350
Conversation
emily-shen
requested review from
a team,
GregBrimble,
ToriLindsay,
WalshyDev,
aninibread,
dario-piotrowicz,
irvinebroque,
penalosa and
petebacondarwin
as code owners
Deploying cloudflare-docs with
|
| Latest commit: |
5ff5e6b
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://839cbf8b.cloudflare-docs-7ou.pages.dev |
| Branch Preview URL: | https://emily-wrangler-telemetry-cmd.cloudflare-docs-7ou.pages.dev |
github-actions
bot
added
product:pages
product:workers
github-actions
bot
assigned
aninibread,
GregBrimble,
irvinebroque,
ToriLindsay,
WalshyDev,
dario-piotrowicz,
penalosa and
petebacondarwin
| - `send_metrics` <Type text="boolean" /> <MetaInfo text="optional" /> | ||
|
|
||
| - Whether Wrangler should send usage metrics to Cloudflare for this project. | ||
| - Whether Wrangler should send usage metrics to Cloudflare for this project. Defaults to `true`. You can learn more about this in our [data policy](https://github.com/cloudflare/workers-sdk/tree/main/telemetry.md). |
There was a problem hiding this comment.
How about this?
Fallbacks to the current wrangler metrics status if not defined. You can learn more about this in our data policy
There was a problem hiding this comment.
seems a bit sneaky to hide that its on by default behind an extra click 🤔
There was a problem hiding this comment.
I'm just worrying if users might come across this and think they have to set sendMetrics = false to turn it off, especially if we prefer them using the telemetry command 🤔
src/content/docs/workers/wrangler/system-environment-variables.mdx
Outdated
Show resolved
Hide resolved
src/content/docs/workers/wrangler/system-environment-variables.mdx
Outdated
Show resolved
Hide resolved
emily-shen
force-pushed
the
emily/wrangler-telemetry-cmds
branch
from
e59c9d2 to
2e32bb6
Compare
|
|
||
| ### `status` | ||
|
|
||
| Check whether telemetry collection is currently enabled. This will resolve the global status set by `wrangler telemetry disable / enable`, the environment variable [`WRANGLER_SEND_METRICS`](/workers/wrangler/system-environment-variables/#supported-environment-variables) and the [`send_metrics`](/workers/wrangler/configuration/#top-level-only-keys) key in `wrangler.toml`. |
There was a problem hiding this comment.
Probably a very basic question, but what do we mean by "resolve"?
There was a problem hiding this comment.
telemetry could be set at a project or user/global level, so this command 'resolves' the telemetry status given where you've run the command. so if you've globally enabled it with npx wrangler telemetry enable but put in send_metrics=false in a specific projects' config, then running npx wrangler telemetry status while you're in that project folder would say telemetry is disabled.
happy to update if you've got a better way of phrasing it though! :))
Co-authored-by: Jun Lee <[email protected]>
13 participants
Summary
Wrangler will be enabling telemetry collection by default for new users (see cloudflare/workers-sdk#7291).
This PR documents the new
wrangler telemetry enable/disable/statuscommands that have been added in the process, and updates existing references to telemetry collection in Wrangler, including adding links to our data policy.Documentation checklist