[wrangler]: add wrangler telemetry commands and update existing info on telemetry collection
#18350
+37
−4
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
emily-shen
requested review from
penalosa,
petebacondarwin,
dario-piotrowicz,
irvinebroque,
GregBrimble,
ToriLindsay,
a team,
WalshyDev and
aninibread
as code owners
9 tasks
Deploying cloudflare-docs with
|
| Latest commit: |
4216eeb
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4c889c59.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
edmundhung
reviewed
Nov 22, 2024
| @@ -296,7 +296,7 @@ Inheritable keys are configurable at the top-level, and can be inherited (or ove | |||
|
|
|||
| - `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 🤔
| @@ -41,6 +41,7 @@ Wrangler offers a number of commands to manage your Cloudflare Workers. | |||
| - [`dispatch-namespace`](#dispatch-namespace) - Interact with a [dispatch namespace](/cloudflare-for-platforms/workers-for-platforms/reference/how-workers-for-platforms-works/#dispatch-namespace). | |||
| - [`mtls-certificate`](#mtls-certificate) - Manage certificates used for mTLS connections. | |||
| - [`types`](#types) - Generate types from bindings and module rules in configuration. | |||
| - [`telemetry`](#telemetry) - Configure whether Wrangler can collect anonymous usage telemetry | |||
There was a problem hiding this comment.
Suggested change
| - [`telemetry`](#telemetry) - Configure whether Wrangler can collect anonymous usage telemetry | |
| - [`telemetry`](#telemetry) - Configure whether Wrangler can collect anonymous usage data. |
There was a problem hiding this comment.
or another option: "Manage Wrangler's collection of anonymous usage data"
|
|
||
| Cloudflare collects anonymous usage data to improve Wrangler. You can learn more about this in our [data policy](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler/telemetry.md). | ||
|
|
||
| You can opt-out of sharing telemetry data at any time using these commands. |
There was a problem hiding this comment.
Suggested change
| You can opt-out of sharing telemetry data at any time using these commands. | |
| You can manage sharing usage data at any time using these commands. |
just trying to reduce the different ways we talk about this. feel like maybe we should keep language to "usage data" as what we collect and "telemetry" as the concept
|
|
||
| * The default value is `"https://api.cloudflare.com/client/v4"`. | ||
| - Options for this are `true` and `false`, the default behavior is `true`. Controls whether Wrangler can send anonymous usage metrics to Cloudflare for this project. You can learn more about this in our [data policy](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler/telemetry.md). |
There was a problem hiding this comment.
Suggested change
| - Options for this are `true` and `false`, the default behavior is `true`. Controls whether Wrangler can send anonymous usage metrics to Cloudflare for this project. You can learn more about this in our [data policy](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler/telemetry.md). | |
| - Options for this are `true` and `false`. Defaults to `true`. Controls whether Wrangler can send anonymous usage data to Cloudflare for this project. You can learn more about this in our [data policy](https://github.com/cloudflare/workers-sdk/tree/main/packages/wrangler/telemetry.md). |
|
|
||
| - Options for Logging levels are `"none"`, `"error"`, `"warn"`, `"info"`, `"log"` and `"debug"`. Levels are case-insensitive and default to `"log"`. If an invalid level is specified, Wrangler will fallback to the default. |
There was a problem hiding this comment.
should we specify here that "log" level will print telemetry data?
|
|
||
| ### `status` | ||
|
|
||
| Check whether telemetry collection is currently enabled. |
There was a problem hiding this comment.
i think we should note here that it's a function of global setting, WRANGLER_SEND_METRICS, and send_metrics, and then point to the data policy, where it's specified the priority of the parameters
emily-shen
force-pushed
the
emily/wrangler-telemetry-cmds
branch
from
e59c9d2
to
2e32bb6
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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