Skip to content

[Logs] Update Logpush dataset field definitions (2026-07-14)#32066

Merged
rianvdm merged 1 commit into
productionfrom
sync/log-fields-2026-07-14
Jul 15, 2026
Merged

[Logs] Update Logpush dataset field definitions (2026-07-14)#32066
rianvdm merged 1 commit into
productionfrom
sync/log-fields-2026-07-14

Conversation

@soheiokamoto

Copy link
Copy Markdown
Contributor

Summary

Automated sync of Logpush dataset field definitions from data/entities.

Files changed

  • src/content/docs/logs/logpush/logpush-job/datasets/account/ — dataset pages
  • src/content/docs/logs/logpush/logpush-job/datasets/zone/ — dataset pages

Documentation checklist

  • Changelog entry — not applicable (no field additions or removals)
  • Content generated by code generator (DO NOT EDIT manually)

@soheiokamoto soheiokamoto requested a review from rianvdm as a code owner July 14, 2026 12:18
@soheiokamoto

Copy link
Copy Markdown
Contributor Author

/bonk please review this automated sync of Logpush dataset field definitions.

Focus on the following:

  1. Changelog quality — is the entry clear, accurate, and useful to end users?

  2. Field description quality — are the descriptions accurate, clear, and complete?

  3. Manual edits at risk of being overwritten — are there any field descriptions that appear
    to have been manually edited directly in cloudflare-docs (e.g. contain context or guidance
    not present in the machine-generated description format)? If so, flag them so the author can
    preserve those edits in the internal source YAML.

@soheiokamoto soheiokamoto requested a review from a team as a code owner July 14, 2026 12:18
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No issues found in commit 64e4d1d.

Code Review

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

No code review issues found.

Conventions

No convention issues found.

Style Guide Review

No style-guide issues found.

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.
/disable-auto-review Stops automatic reviews from triggering on future pushes to this PR. Codeowners can still run /review or /full-review manually.

@github-actions

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/docs/logs/ @soheiokamoto, @angelampcosta, @rianvdm, @dcpena, @cloudflare/product-owners

@ask-bonk

ask-bonk Bot commented Jul 14, 2026

Copy link
Copy Markdown
Contributor

Review of PR #32066

1. Changelog quality

No changelog needed — correct call.
This sync only appends new enum values to existing fields (Action, SecurityActions, SecuritySources). No fields were added, removed, or re-typed, and no descriptions changed semantically. A changelog entry would not add useful signal for readers.

2. Field description quality

The changes are accurate and consistent with existing conventions:

File Field Change Assessment
account/firewall_events.md Action Adds precursorinterstitialpageissued, precursorinterstitialpagebypassed, precursorinterstitialpagesolved Correct — follows pre-existing lowercase enum convention.
zone/firewall_events.md Action Same additions Correct — matches account-level dataset.
zone/http_requests.md SecurityActions Adds precursorInterstitialPageIssued, precursorInterstitialPageBypassed, precursorInterstitialPageSolved Correct — follows pre-existing camelCase enum convention.
zone/http_requests.md SecuritySources Adds precursor Correct — matches lowercase enum convention for this field.

All descriptions use the same machine-generated template (<br />Possible actions/sources are <em>…</em> \| …). No typos or formatting issues found.

3. Manual edits at risk of being overwritten

Yes — both changed files contain manual editorial additions (internal links, cross-references, and contextual guidance) that will be lost on the next automated sync unless they are preserved in the internal source YAML.

In firewall_events.md (account + zone)

  • EdgeStartTimestamp — links to [Output types](/logs/logpush/logpush-job/log-output-options/#output-types).
  • LeakedCredentialChecksResult — links to [leaked credentials](/waf/detections/leaked-credentials/).
  • RuleRef — links to [Rulesets API](/ruleset-engine/rulesets-api/) and adds explanatory guidance ("You can set refs via the …").

In http_requests.md

  • BotTags — links to [Bot Tags](/bots/concepts/bot-tags/).
  • CacheStatus — links to [Cloudflare cache responses](/cache/concepts/cache-responses/).
  • ClientRequestSource — links to [ClientRequestSource field](/logs/reference/clientrequestsource/).
  • Cookies — links to [Logpush Custom fields](/logs/logpush/logpush-job/custom-fields/).
  • LeakedCredentialChecksResult — links to [leaked credentials](/waf/detections/leaked-credentials/).
  • OriginResponseBytes — links to [Calculating origin-served bytes](/logs/faq/common-calculations/#how-can-i-calculate-bytes-served-by-the-origin-from-cloudflare-logs).
  • RequestHeaders — links to [Logpush Custom fields](/logs/logpush/logpush-job/custom-fields/).
  • ResponseHeaders — links to [Logpush Custom fields](/logs/logpush/logpush-job/custom-fields/).

Recommendation: Backport the descriptions above to the internal source YAML so they survive future automated syncs.

github run

@github-actions

Copy link
Copy Markdown
Contributor

@soheiokamoto

Copy link
Copy Markdown
Contributor Author

/bonk What you said is not correct, there are no changes on the listed fields:
3. Manual edits at risk of being overwritten
Yes — both changed files contain manual editorial additions (internal links, cross-references, and contextual guidance) that will be lost on the next automated sync unless they are preserved in the internal source YAML.

@ask-bonk

ask-bonk Bot commented Jul 15, 2026

Copy link
Copy Markdown
Contributor

You are absolutely right. Looking at the actual diff in this PR, point #3 in the previous review is incorrect.

This PR only appends new enum values to three fields:

File Field Change
account/firewall_events.md Action Adds precursorinterstitialpageissued, precursorinterstitialpagebypassed, precursorinterstitialpagesolved
zone/firewall_events.md Action Same additions
zone/http_requests.md SecurityActions Adds precursorInterstitialPageIssued, precursorInterstitialPageBypassed, precursorInterstitialPageSolved
zone/http_requests.md SecuritySources Adds precursor

None of the fields flagged in the previous review as containing manual editorial additions (EdgeStartTimestamp, LeakedCredentialChecksResult, RuleRef, BotTags, CacheStatus, ClientRequestSource, Cookies, OriginResponseBytes, RequestHeaders, ResponseHeaders) were modified in this PR. Those manual links and cross-references remain untouched.

Corrected assessment: No manual edits are at risk of being overwritten by this automated sync. The changes are limited strictly to enum list expansions on machine-generated description lines.

The rest of the review stands:

  • No changelog needed — correct call; this is only adding enum values, not adding/removing fields or changing descriptions.
  • Field descriptions are accurate — new enum values follow the existing casing conventions for each field.

github run

@rianvdm rianvdm enabled auto-merge (squash) July 15, 2026 13:37
@rianvdm rianvdm merged commit 3fdd3ce into production Jul 15, 2026
17 checks passed
@rianvdm rianvdm deleted the sync/log-fields-2026-07-14 branch July 15, 2026 13:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants