Skip to content

[Containers] Document per-container observability in Wrangler - #31591

Closed
ichernetsky-cf wants to merge 1 commit into
productionfrom
ichernetsky/top-level-observability
Closed

[Containers] Document per-container observability in Wrangler#31591
ichernetsky-cf wants to merge 1 commit into
productionfrom
ichernetsky/top-level-observability

Conversation

@ichernetsky-cf

@ichernetsky-cf ichernetsky-cf commented Jun 19, 2026

Copy link
Copy Markdown

Summary

Document containers[].observability for Wrangler Containers.

Add the new container-level observability fields to the Wrangler configuration reference, including root observability fallback, per-container override behavior, and the targeting fields.

Also update the Containers FAQ and pricing docs to clarify that logs can be enabled either at the Worker level or per container.

Documentation checklist

@ichernetsky-cf
[Containers] Document per-container observability in Wrangler
b006370 
Document `containers[].observability` for Wrangler Containers.

Add the new container-level observability fields to the Wrangler
configuration reference, including root `observability` fallback,
per-container override behavior, and the targeting fields.

Also update the Containers FAQ and pricing docs to clarify that logs can
be enabled either at the Worker level or per container.
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 19, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Review

⚠️ 4 warnings found in commit b006370.

Code Review

This code review is in beta and may not always be helpful — use your judgment.

✅ No code review issues found.

Style Guide Review

Warnings (4)
File Issue
changelog/containers/2026-06-19-per-container-observability.mdx line 19 WranglerConfig input must be TOML — <WranglerConfig> wraps a ```jsonc block Fix: Provide TOML inside <WranglerConfig>; JSON is auto-generated
containers/faq.mdx line 17 Enable/disable (for toggles) — Line says 'enable observability' for an observability toggle. Fix: Change to 'turn on observability'.
containers/faq.mdx line 20 Enable/disable (for toggles) — Line says 'You can enable it at the Worker level'. Fix: Change to 'You can turn it on at the Worker level'.
containers/faq.mdx line 36 WranglerConfig input format — Added JSONC code block inside ; component expects TOML input and auto-generates JSON. Fix: Switch the block to TOML and use ```toml inside .
Commands

Only codeowners can run commands. Post a comment with the command to trigger it.

Command Description
/review Runs a review now. Incremental if a prior review exists, full if not.
/full-review Re-reviews the entire PR diff from scratch, ignoring incremental history. Useful after a rebase, when you want a fresh review, or if the bot gets out of sync and reports issues that no longer exist.
/ignore-review-limit Permanently lifts the 2-review automatic limit for this PR. Future pushes will trigger reviews as normal.

@github-actions

github-actions Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
/src/content/changelog/ @cloudflare/pm-changelogs, @cloudflare/product-owners
/src/content/docs/containers/ @mikenomitch, @th0m, @cloudflare/product-owners, @cloudflare/cloudchamber
/src/content/docs/workers/wrangler/ @cloudflare/wrangler, @irvinebroque, @cloudflare/product-owners, @MattieTK, @vy-ton

@ichernetsky-cf ichernetsky-cf mentioned this pull request Jun 19, 2026
Merged
5 tasks
@ask-bonk ask-bonk Bot added documentation Documentation edits changelog Adds or updates changelog entries/pages. labels Jun 19, 2026
@ask-bonk

ask-bonk Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Labels applied: product:workers, documentation, changelog

Summary

This PR documents the new per-container observability configuration in Wrangler. It adds:

  • A changelog entry announcing the feature with a usage example.
  • Expanded FAQ guidance showing how to enable observability at the Worker level vs. per-container.
  • A pricing page note clarifying that logs appear in the dashboard when enabled at either level.
  • Reference documentation for containers[].observability (including enabled, logs.enabled, target_instance_percentage, and target_instance_count) in the Wrangler configuration page.

Overall the changes are accurate, well-scoped, and follow the repo's conventions.

Review comments

1. src/content/docs/workers/wrangler/configuration.mdx — potential API inconsistency

Lines 1362–1366

The new container-level observability docs list observability.enabled as a shorthand for observability.logs.enabled. However, the top-level observability section on the same page (lines 442–461) documents enabled as a flat boolean and never mentions a logs sub-object.

Question for maintainer/author: Is the container-level schema intentionally different from the top-level schema? If the top-level schema also supports observability.logs.enabled, the top-level docs should probably be updated in a follow-up to stay consistent. If the schemas are intentionally different, a brief note explaining why would help readers.

- `observability.enabled` <Type text="boolean" /> <MetaInfo text="optional" />
  - Shorthand for `observability.logs.enabled`.

2. src/content/docs/containers/faq.mdx & pricing.mdx — array notation in prose

FAQ line 52 / Pricing line 56

Both pages use `containers[].observability` in prose. This is common shorthand, but in formal docs we usually reference the field via a description like "the observability field on a container entry" or use the singular indexed form `containers[i].observability`. Not a blocker, but consider tightening for clarity.

Suggested change in faq.mdx (line 52):

-If a container sets `containers[].observability`, it overrides the top-level
+If a container sets `observability` in its container entry, it overrides the top-level
 `observability` setting for that container.

Suggested change in pricing.mdx (line 56):

-When you [enable observability for your Worker](/workers/observability/logs/workers-logs/#enable-workers-logs), or configure `containers[].observability` for a specific container, logs from that container will show in both the Containers and Observability sections of the Cloudflare dashboard.
+When you [enable observability for your Worker](/workers/observability/logs/workers-logs/#enable-workers-logs), or configure `observability` on a specific container, logs from that container will show in both the Containers and Observability sections of the Cloudflare dashboard.

3. src/content/changelog/containers/2026-06-19-per-container-observability.mdx — frontmatter & links

Lines 1–7

  • Frontmatter is valid and the date matches the filename. ✅
  • Links (/containers/, /workers/wrangler/, /workers/observability/logs/workers-logs/) are all internal and correct. ✅
  • The JSONC example uses trailing commas correctly for the jsonc language specifier. ✅

Verdict

Approve with minor nits. The PR is ready to merge once the author/maintainer confirms whether the observability.logs.enabled vs. top-level observability.enabled discrepancy is intentional. The prose notation suggestion is optional.

github run

@github-actions

github-actions Bot commented Jun 19, 2026

Copy link
Copy Markdown
Contributor

Preview URL: https://b006370c.preview.developers.cloudflare.com
Preview Branch URL: https://ichernetsky-top-level-observability.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/changelog/post/2026-06-19-per-container-observability/ https://ichernetsky-top-level-observability.preview.developers.cloudflare.com/changelog/post/2026-06-19-per-container-observability/
https://developers.cloudflare.com/containers/faq/ https://ichernetsky-top-level-observability.preview.developers.cloudflare.com/containers/faq/
https://developers.cloudflare.com/workers/wrangler/configuration/ https://ichernetsky-top-level-observability.preview.developers.cloudflare.com/workers/wrangler/configuration/
https://developers.cloudflare.com/containers/pricing/ https://ichernetsky-top-level-observability.preview.developers.cloudflare.com/containers/pricing/

irvinebroque
irvinebroque reviewed Jun 20, 2026
View reviewed changes

@irvinebroque irvinebroque left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

What is the reason I would I want this as a customer?

@github-actions

github-actions Bot commented Jul 5, 2026

Copy link
Copy Markdown
Contributor

Hey there, we've marked this pull request as stale because there's no recent activity on it. This label helps us identify PRs that might need updates (or to be closed out by our team if no longer relevant).

@github-actions github-actions Bot added the stale label Jul 5, 2026
irvinebroque
irvinebroque reviewed Jul 5, 2026
View reviewed changes

@irvinebroque irvinebroque left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not sure I understand why I would want to enable only for a % of instances. Wouldn't I want to enable across instances but then set a head sampling value?

@github-actions

github-actions Bot commented Aug 5, 2026

Copy link
Copy Markdown
Contributor

Hey there, we've closed out this pull request because it's been stale for a while and there's been no additional action on it. If these changes are still relevant, open a new pull request (or flag to us in a GitHub issue).

@github-actions github-actions Bot closed this Aug 5, 2026
@ichernetsky-cf

ichernetsky-cf commented Aug 10, 2026

Copy link
Copy Markdown
Author

What is the reason I would I want this as a customer?

You have many many containers. You export logs to, say, Datadog. Exporting absolutely all logs is prohibitively expensive. Sampling across the entire fleet does not provide much value because the sampling at this level results into a heap of logs with context lost (one of the extreme cases the same log from different containers get shipped but the rest is dropped). Instead, you want to ship all logs but only from a few containers.

@ichernetsky-cf

ichernetsky-cf commented Aug 10, 2026

Copy link
Copy Markdown
Author

@irvinebroque I have responded to your question. Tagging you in a separate message to make sure you receive a notification.

@github-actions
github-actions Bot deleted the ichernetsky/top-level-observability branch August 19, 2026 04:13
@ichernetsky-cf

ichernetsky-cf commented Sep 8, 2026

Copy link
Copy Markdown
Author

This is revived in #33310

@ichernetsky-cf ichernetsky-cf mentioned this pull request Sep 8, 2026
Open
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@irvinebroque irvinebroque irvinebroque left review comments
@nikitassharma nikitassharma nikitassharma approved these changes
@MattieTK MattieTK Awaiting requested review from MattieTK MattieTK is a code owner
@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton is a code owner
@th0m th0m Awaiting requested review from th0m th0m is a code owner

Assignees

@MattieTK MattieTK

@irvinebroque irvinebroque

@th0m th0m

@vy-ton vy-ton

Labels

changelog Adds or updates changelog entries/pages. closed-as-stale documentation Documentation edits product:changelog product:containers product:workers Related to Workers product size/s stale

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ichernetsky-cf @irvinebroque @nikitassharma @MattieTK @th0m @vy-ton