Skip to content

OBSDOCS-1772: Document RFC5424 default field mappings (6.3-6.6) - #116468

Open
johnwilkins wants to merge 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-1772-main
Open

OBSDOCS-1772: Document RFC5424 default field mappings (6.3-6.6)#116468
johnwilkins wants to merge 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-1772-main

Conversation

@johnwilkins

@johnwilkins johnwilkins commented Jul 24, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the default RFC5424 field mappings for syslog outputs in Logging 6.3-6.6.

This PR adds documentation for the default values that the collector uses for APP-NAME, PROCID, and MSGID fields when using RFC5424 syslog protocol. These defaults were introduced in Logging 6.0 but were not previously documented.

Note: This PR complements #116467, which adds the same documentation plus a breaking change notice in the 6.2.0 release notes. This PR is for the main logging docs (versions 6.3-6.6).

Changes

  • Syslog forwarding docs: Added new section documenting default field mappings by log source type (infrastructure journal/container, application, audit)
  • Included notes about field length limits and truncation behavior

Testing

  • ✅ Local build validation: All AsciiDoc assemblies validated successfully
  • ✅ Portal build: All books built successfully

Versions

6.6, 6.5, 6.4, 6.3 (#116467 handles 6.2)

JIRA

Fixes: https://redhat.atlassian.net/browse/OBSDOCS-1772

Signed-off-by: John Wilkins jowilkin@redhat.com

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Jul 24, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 24, 2026

Copy link
Copy Markdown

@johnwilkins: This pull request references OBSDOCS-1772 which is a valid jira issue.

Details

In response to this:

Summary

Documents the default RFC5424 field mappings for syslog outputs in Logging 6.3-6.6.

This PR adds documentation for the default values that the collector uses for APP-NAME, PROCID, and MSGID fields when using RFC5424 syslog protocol. These defaults were introduced in Logging 6.0 but were not previously documented.

Note: This PR complements #116467, which adds the same documentation plus a breaking change notice in the 6.2.0 release notes. This PR is for the main logging docs (versions 6.3-6.6).

Changes

  • Syslog forwarding docs: Added new section documenting default field mappings by log source type (infrastructure journal/container, application, audit)
  • Included notes about field length limits and truncation behavior

Testing

  • ✅ Local build validation: All AsciiDoc assemblies validated successfully
  • ✅ Portal build: All books built successfully

JIRA

Fixes: https://redhat.atlassian.net/browse/OBSDOCS-1772

🤖 Generated with Claude Code

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the openshift-eng/jira-lifecycle-plugin repository.

@openshift-ci openshift-ci Bot added the size/M Denotes a PR that changes 30-99 lines, ignoring generated files. label Jul 24, 2026
Add documentation for default RFC5424 field mappings in syslog
forwarding procedure for Logging 6.3-6.6.

In Logging 6, the RFC5424 syslog format uses new default values
for APP-NAME, PROCID, and MSGID fields that differ from previous
versions. This helps users understand what values are populated
when they don't explicitly set these fields.

Changes:
- Create new CONCEPT module for RFC5424 default field mappings
  (DITA compliant - concept module separate from procedure)
- Add table documenting default field mappings by log source type
  (infrastructure journal/container, application, audit)
- Include note about field length limits and truncation behavior
- Include new module in configuring-log-forwarding assembly

Testing:
- Vale: 0 errors, 0 warnings
- Local prow validation: All assemblies and portal builds passed
- DITA compliance: Verified with separate CONCEPT module

Signed-off-by: John Wilkins <jowilkin@redhat.com>
@ocpdocs-previewbot

Copy link
Copy Markdown

🤖 Fri Jul 24 18:48:11 - Prow CI generated the docs preview:

https://116468--ocpdocs-pr.netlify.app/openshift-logging/latest/configuring/configuring-log-forwarding.html

@openshift-ci

openshift-ci Bot commented Jul 24, 2026

Copy link
Copy Markdown

@johnwilkins: all tests passed!

Full PR test history. Your PR dashboard.

Details

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

@linuxstudio

Copy link
Copy Markdown

Compared to github.com//pull/116467 I see that here there is no indentation of sections:

  • forwarding logs using the syslog protocol
  • default field mappings for RFC5424
    under the parent:
  • forwarding application logs from specific pods

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

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants