Skip to content

Commit

Permalink
[c3] telemetry docs
Browse files Browse the repository at this point in the history
  • Loading branch information
edmundhung committed Sep 9, 2024
1 parent 2111cd3 commit 61fb9a0
Showing 1 changed file with 42 additions and 1 deletion.
43 changes: 42 additions & 1 deletion src/content/docs/pages/get-started/c3.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description: Use C3 (`create-cloudflare` CLI) to set up and deploy new
deployment.
---

import { Render, TabItem, Tabs } from "~/components";
import { Render, TabItem, Tabs, PackageManagers } from "~/components";

Cloudflare provides a CLI command for creating new Workers and Pages projects — `npm create cloudflare`, powered by the [`create-cloudflare` package](https://www.npmjs.com/package/create-cloudflare).

Expand Down Expand Up @@ -221,3 +221,44 @@ bun create cloudflare@latest [--] [<DIRECTORY>] [OPTIONS] [-- <NESTED ARGS...>]
All the boolean options above can be specified with or without a value, for example `--open` and `--open true` have the same effect, prefixing `no-` to the option's name negates it, so for example `--no-open` and `--open false` have the same effect.

:::

## Telemetry

Cloudflare collects anonymous usage data to improve create-cloudflare over time. You may opt-out if you'd not like to share any information.

### Events

We track general usage information, including:

- Arguments passed to the CLI and the answers to each prompts
- Versions of create-cloudflare
- General machine information (e.g. MacOS/Linux/Windows, which package manager is being used)
- Duration of each prompts

You can find the list of events in the [repository](https://github.com/cloudflare/workers-sdk/tree/main/packages/create-cloudflare/src/events.ts).

### Opting-out

You can disable create-cloudflare from collecting usage data with `create-cloudflare telemetry disable`.

<PackageManagers
type="create"
pkg="cloudflare@latest"
args="telemetry disable"
/>

You can check the status of telemetry collection at any time by running `create-cloudflare telemetry status`.

<PackageManagers
type="create"
pkg="cloudflare@latest"
args="telemetry status"
/>

You can always re-enable telemetry collection by running `create-cloudflare telemetry enable`.

<PackageManagers
type="create"
pkg="cloudflare@latest"
args="telemetry enable"
/>

0 comments on commit 61fb9a0

Please sign in to comment.