Skip to content

[Logs]Update workers-logs.mdx #18067

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

Closed
wants to merge 1 commit into from
Closed

[Logs]Update workers-logs.mdx #18067

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
5 changes: 4 additions & 1 deletion src/content/docs/workers/observability/logs/workers-logs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -147,14 +147,17 @@ After you deploy the code above, view your Worker's logs in [the dashboard](/wor

Head-based sampling allows you to log a percentage of incoming requests to your Cloudflare Worker. Especially for high-traffic applications, this helps reduce log volume and manage costs, while still providing meaningful insights into your application's performance. When you configure a head-based sampling rate, you can control the percentage of requests that get logged. All logs within the context of the request are collected.

To enable head-based sampling, set `head_sampling_rate` within the observability configuration. The valid range is from 0 to 1, where 0 indicates zero out of one hundred requests are logged, and 1 indicates every request is logged. If `head_sampling_rate` is unspecified, it is configured to a default value of 1 (100%). In the example below, `head_sampling_rate` is set to 0.01, which means one out of every one hundred requests is logged.
To enable head-based sampling, set `head_sampling_rate` within the observability configuration in your Worker's `wrangler.toml`. The valid range is from 0 to 1, where 0 indicates zero out of one hundred requests are logged, and 1 indicates every request is logged. If `head_sampling_rate` is unspecified, it is configured to a default value of 1 (100%). In the example below, `head_sampling_rate` is set to 0.01, which means one out of every one hundred requests is logged.

```toml
[observability]
enabled = true
head_sampling_rate = 0.01 # 1% sampling rate
```
:::note
Copy link
Contributor

@rohinlohe rohinlohe Nov 11, 2024 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's remove this note from the change, please.

The head-based sampling range displayed on the Cloudflare dashboard is from 0 to 100(%).

:::
## Limits

| Description | Retention |
Expand Down
Loading