You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Fix durable-object and observability sections of wrangler.toml docs (#17800)
* [Workers] Document Durable Object migrations in configuration
and add missing brace in renamed_classes
* [Workers] Fix observabilty and logpush wrangler configuration
* fix type info
* remove duplicate example toml key
* link to logpush info
* [Workers] lift observability in wrangler configuration
It is not a binding. It is a script-setting, which lives somewhere
between triggers and versioned settings (including bindings).
- When making changes to your Durable Object classes, you must perform a migration. Refer to [Durable Object migrations](/durable-objects/reference/durable-objects-migrations/).
- Enables Workers Trace Events Logpush for a Worker. Any scripts with this property will automatically get picked up by the Workers Logpush job configured for your account. Defaults to `false`.
168
+
- Enables Workers Trace Events Logpush for a Worker. Any scripts with this property will automatically get picked up by the Workers Logpush job configured for your account. Defaults to `false`. Refer to [Workers Logpush](/workers/observability/logs/logpush/).
- Configures automatic observability settings for telemetry data emitted from your Worker. Refer to [Observability](#observability).
173
177
@@ -322,6 +326,26 @@ Example:
322
326
crons = ["* * * * *"]
323
327
```
324
328
329
+
## Observability
330
+
331
+
The [Observability](/workers/observability/logs/workers-logs) setting allows you to automatically ingest, store, filter, and analyze logging data emitted from Cloudflare Workers directly from your Cloudflare Worker's dashboard.
- A number between 0 and 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%). Read more about [head-based sampling](/workers/observability/logs/workers-logs/#head-based-sampling).
339
+
340
+
Example:
341
+
342
+
```toml title="wrangler.toml"
343
+
[observability]
344
+
enabled = true
345
+
head_sampling_rate = 0.1# 10% of requests are logged
346
+
```
347
+
348
+
325
349
## Custom builds
326
350
327
351
You can configure a custom build step that will be run before your Worker is deployed. Refer to [Custom builds](/workers/wrangler/custom-builds/).
@@ -510,7 +534,7 @@ When making changes to your Durable Object classes, you must perform a migration
510
534
511
535
- The new Durable Objects being defined.
512
536
513
-
-`renamed_classes` <Typetext="from: string, to: string}[]" /> <MetaInfotext="optional" />
537
+
-`renamed_classes` <Typetext="{from: string, to: string}[]" /> <MetaInfotext="optional" />
514
538
515
539
- The Durable Objects being renamed.
516
540
@@ -629,28 +653,6 @@ binding = "<BINDING_NAME2>"
629
653
id = "<NAMESPACE_ID2>"
630
654
```
631
655
632
-
### Observability
633
-
634
-
The [Observability](/workers/observability/logs/workers-logs) setting allows you to automatically ingest, store, filter, and analyze logging data emitted from Cloudflare Workers directly from your Cloudflare Worker's dashboard.
635
-
636
-
-`enabled` boolean required
637
-
638
-
- When set to `true` on a Worker, logs for the Worker are persisted. Defaults to `true` for all new Workers.
639
-
640
-
-`head_sampling_rate` number optional
641
-
- A number between 0 and 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%). Read more about [head-based sampling](/workers/observability/logs/workers-logs/#head-based-sampling).
642
-
643
-
Example:
644
-
645
-
```toml title="wrangler.toml"
646
-
[observability]
647
-
enabled = true
648
-
649
-
[observability]
650
-
enabled = true
651
-
head_sampling_rate = 0.1# 10% of requests are logged
652
-
```
653
-
654
656
### Queues
655
657
656
658
[Queues](/queues/) is Cloudflare's global message queueing service, providing [guaranteed delivery](/queues/reference/delivery-guarantees/) and [message batching](/queues/configuration/batching-retries/). To interact with a queue with Workers, you need a producer Worker to send messages to the queue and a consumer Worker to pull batches of messages out of the Queue. A single Worker can produce to and consume from multiple Queues.
0 commit comments