Skip to content

[Logs] Update Logpush dataset field definitions (2026-06-16)#31486

Closed
soheiokamoto wants to merge 1 commit into
productionfrom
sync/log-fields-2026-06-16
Closed

[Logs] Update Logpush dataset field definitions (2026-06-16)#31486
soheiokamoto wants to merge 1 commit into
productionfrom
sync/log-fields-2026-06-16

Conversation

@soheiokamoto

Copy link
Copy Markdown
Contributor

Summary

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

New datasets

  • WebSocket Analytics: A new dataset with fields including BytesReceivedClient, BytesReceivedOrigin, BytesSentClient, BytesSentOrigin, ClientASN, ClientIP, ClientRequestHost, ClientRequestPath, ClientRequestUserAgent, ColoCode, ConnectionCloseReason, ConnectionCloseSource, ConnectionID, ConnectionTransportCloseCode, EdgeEndTimestamp, EdgeStartTimestamp, and RayID.
  • WebSocket Analytics: A new dataset with fields including BytesReceivedClient, BytesReceivedOrigin, BytesSentClient, BytesSentOrigin, ClientASN, ClientIP, ClientRequestHost, ClientRequestPath, ClientRequestUserAgent, ColoCode, ConnectionCloseReason, ConnectionCloseSource, ConnectionID, ConnectionTransportCloseCode, EdgeEndTimestamp, EdgeStartTimestamp, and RayID.

Updated fields in existing datasets

  • Email Security Alerts (added): BCC, DKIMResult, DMARCPolicy, DMARCResult, and SPFResult.

Files changed

  • src/content/docs/logs/logpush/logpush-job/datasets/account/ — dataset pages
  • src/content/docs/logs/logpush/logpush-job/datasets/zone/ — dataset pages
  • src/content/changelog/logs/2026-06-16-log-fields-updated.mdx — changelog

Documentation checklist

  • Changelog entry added
  • Content generated by code generator (DO NOT EDIT manually)

@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 review from a team and rianvdm as code owners June 16, 2026 13:55
@cloudflare-docs-bot

cloudflare-docs-bot Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review

✅ No style-guide issues found in commit aab4d93.

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.

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

@ask-bonk ask-bonk Bot 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.

1 issue needs fixing before merge.

Duplicate changelog entry — The 'New datasets' section lists WebSocket Analytics twice (lines 11–12). This appears to be a code generator bug in the source data or template. The PR description also contains the same duplicate.

Labels — Already appropriately labeled (, , ).

Manual edit risk — No manual edits appear at risk of being overwritten. All new field descriptions in and both files follow the generated format consistently.

Field description quality — Descriptions are accurate and consistent with existing generated dataset pages. The new WebSocket Analytics fields and Email Security Alert fields look correct.

Comment on lines +11 to +12
- **WebSocket Analytics**: A new dataset with fields including `BytesReceivedClient`, `BytesReceivedOrigin`, `BytesSentClient`, `BytesSentOrigin`, `ClientASN`, `ClientIP`, `ClientRequestHost`, `ClientRequestPath`, `ClientRequestUserAgent`, `ColoCode`, `ConnectionCloseReason`, `ConnectionCloseSource`, `ConnectionID`, `ConnectionTransportCloseCode`, `EdgeEndTimestamp`, `EdgeStartTimestamp`, and `RayID`.
- **WebSocket Analytics**: A new dataset with fields including `BytesReceivedClient`, `BytesReceivedOrigin`, `BytesSentClient`, `BytesSentOrigin`, `ClientASN`, `ClientIP`, `ClientRequestHost`, `ClientRequestPath`, `ClientRequestUserAgent`, `ColoCode`, `ConnectionCloseReason`, `ConnectionCloseSource`, `ConnectionID`, `ConnectionTransportCloseCode`, `EdgeEndTimestamp`, `EdgeStartTimestamp`, and `RayID`.

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.

Remove the duplicate WebSocket Analytics bullet. Check the generator source — this dataset may be emitted twice.

Suggested change
- **WebSocket Analytics**: A new dataset with fields including `BytesReceivedClient`, `BytesReceivedOrigin`, `BytesSentClient`, `BytesSentOrigin`, `ClientASN`, `ClientIP`, `ClientRequestHost`, `ClientRequestPath`, `ClientRequestUserAgent`, `ColoCode`, `ConnectionCloseReason`, `ConnectionCloseSource`, `ConnectionID`, `ConnectionTransportCloseCode`, `EdgeEndTimestamp`, `EdgeStartTimestamp`, and `RayID`.
- **WebSocket Analytics**: A new dataset with fields including `BytesReceivedClient`, `BytesReceivedOrigin`, `BytesSentClient`, `BytesSentOrigin`, `ClientASN`, `ClientIP`, `ClientRequestHost`, `ClientRequestPath`, `ClientRequestUserAgent`, `ColoCode`, `ConnectionCloseReason`, `ConnectionCloseSource`, `ConnectionID`, `ConnectionTransportCloseCode`, `EdgeEndTimestamp`, `EdgeStartTimestamp`, and `RayID`.
- **WebSocket Analytics**: A new dataset with fields including `BytesReceivedClient`, `BytesReceivedOrigin`, `BytesSentClient`, `BytesSentOrigin`, `ClientASN`, `ClientIP`, `ClientRequestHost`, `ClientRequestPath`, `ClientRequestUserAgent`, `ColoCode`, `ConnectionCloseReason`, `ConnectionCloseSource`, `ConnectionID`, `ConnectionTransportCloseCode`, `EdgeEndTimestamp`, `EdgeStartTimestamp`, and `RayID`.

@ask-bonk

ask-bonk Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

Review supplement — the rendered review body dropped the backtick-quoted text due to a shell escaping issue. Here is the intended summary:

1 issue needs fixing before merge.

Duplicate changelog entry — The New datasets section lists WebSocket Analytics twice (lines 11–12). This appears to be a code generator bug in the source data or template. The PR description also contains the same duplicate.

Labels — Already appropriately labeled (product:logs, product:changelog, size/m).

Manual edit risk — No manual edits appear at risk of being overwritten. All new field descriptions in email_security_alerts.md and both websocket_analytics.md files follow the generated format consistently.

Field description quality — Descriptions are accurate and consistent with existing generated dataset pages. The new WebSocket Analytics fields and Email Security Alert fields look correct.

@ask-bonk

ask-bonk Bot commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

I reviewed PR #31486 and posted my feedback directly on the pull request.

Summary

The PR is an automated sync that adds:

  • WebSocket Analytics dataset definitions for both account and zone scopes (websocket_analytics.md)
  • 5 new fields to the Email Security Alerts dataset (BCC, DKIMResult, DMARCPolicy, DMARCResult, SPFResult)
  • A changelog entry documenting these changes

Issue Found

Duplicate changelog entry — The "New datasets" section of the changelog lists WebSocket Analytics twice (consecutive identical bullets). This appears to be a code generator bug. I posted an inline suggestion to remove the duplicate line and flagged that the PR description has the same duplication.

Labels

The PR is already appropriately labeled:

  • product:logs
  • product:changelog
  • size/m

Manual Edit Risk

No manual edits appear at risk of being overwritten. All new field descriptions follow the standard generated format used across other Logpush dataset pages.

github run

@soheiokamoto

Copy link
Copy Markdown
Contributor Author

Closed in favor of #31674

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants