Skip to content

update Wrangler env-vars to include WRANGLER_LOG_SANITIZE and WRANGLER_SEND_ERROR_REPORTS #25605

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

Open
wants to merge 1 commit into
base: production
Choose a base branch
from
Open

update Wrangler env-vars to include WRANGLER_LOG_SANITIZE and WRANGLER_SEND_ERROR_REPORTS #25605

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
11 changes: 10 additions & 1 deletion src/content/docs/workers/wrangler/system-environment-variables.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,14 @@ Wrangler supports the following environment variables:

- The email address associated with your Cloudflare account, usually used for older authentication method with `CLOUDFLARE_API_KEY=`.

- `WRANGLER_SEND_METRICS` <Type text="string" /> <MetaInfo text="optional" />
- `WRANGLER_SEND_METRICS` <Type text="boolean" /> <MetaInfo text="optional" />

- 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).

- `WRANGLER_SEND_ERROR_REPORTS` <Type text="boolean" /> <MetaInfo text="optional" />

- Options for this are `true` and `false`. Defaults to `undefined`. Controls whether Wrangler can send non-user error reports to Cloudflare for this project. If `undefined`, Wrangler will ask the user whether to send an error report each time there is a non-user error.

- `CLOUDFLARE_HYPERDRIVE_LOCAL_CONNECTION_STRING_<BINDING_NAME>`<Type text="string" /> <MetaInfo text="optional" />

- The [local connection string](/hyperdrive/configuration/local-development/) for your database to use in local development with [Hyperdrive](/hyperdrive/). For example, if the binding for your Hyperdrive is named `PROD_DB`, this would be `CLOUDFLARE_HYPERDRIVE_LOCAL_CONNECTION_STRING_PROD_DB="postgres://user:[email protected]:5432/testdb"`. Each Hyperdrive is uniquely distinguished by the binding name.
Expand All @@ -71,6 +75,10 @@ Wrangler supports the following environment variables:

- A file or directory path where Wrangler will write debug logs. If the path ends in `.log`, Wrangler will consider this the path to a file where all logs will be written. Otherwise, Wrangler will treat the path as a directory where it will write one or more log files using a timestamp for the filenames.

- `WRANGLER_LOG_SANITIZE` <Type text="boolean" /> <MetaInfo text="optional" />

- Options for this are `true` and `false`. Defaults to `true`. Controls whether Wrangler will sanitize any sensitive information from logs written to the console or to a log file. Sensitive information includes API tokens, email addresses, account IDs, and more.

- `FORCE_COLOR` <Type text="string" /> <MetaInfo text="optional" />
- By setting this to `0`, you can disable Wrangler's colorised output, which makes it easier to read with some terminal setups. For example, `FORCE_COLOR=0`.

Expand All @@ -86,6 +94,7 @@ Wrangler supports the following environment variables:

* `WRANGLER_R2_SQL_AUTH_TOKEN` <Type text="string" /> <MetaInfo text="optional" />
- API token used for executing queries with [R2 SQL](/r2-sql).

## Example `.env` file

The following is an example `.env` file:
Expand Down
Loading