Skip to content

OBSDOCS-3110: Document HTTP output format parameter#114512

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

OBSDOCS-3110: Document HTTP output format parameter#114512
johnwilkins wants to merge 1 commit into
openshift:standalone-logging-docs-mainfrom
johnwilkins:OBSDOCS-3110

Conversation

@johnwilkins

@johnwilkins johnwilkins commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new format parameter for HTTP outputs in ClusterLogForwarder, which allows users to specify the data format for logs sent to HTTP endpoints.

Changes

Modified Module:

  • logging-http-forward.adoc: Added format field documentation and example

Format Options

  • json (default) - Standard JSON format
  • ndjson - Newline-delimited JSON for systems that process logs line by line

Use Case

The ndjson format is required for systems like VictoriaLogs and other log aggregation platforms that expect newline-delimited JSON format instead of standard JSON arrays.

Example

outputs:
  - name: http-receiver
    type: http
    http:
      url: 'https://victorialogs.example.com/insert/jsonline'
      format: ndjson

Testing

  • ✅ Vale check passed (0 errors, 0 warnings, 3 suggestions)
  • ✅ Field description clear and concise
  • ✅ Use case explained

Related

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

🤖 Generated with Claude Code

@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 1, 2026
@openshift-ci-robot

openshift-ci-robot commented Jul 1, 2026

Copy link
Copy Markdown

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

Details

In response to this:

Summary

Documents the new format parameter for HTTP outputs in ClusterLogForwarder, which allows users to specify the data format for logs sent to HTTP endpoints.

Changes

Modified Module:

  • logging-http-forward.adoc: Added format field documentation and example

Format Options

  • json (default) - Standard JSON format
  • ndjson - Newline-delimited JSON for systems that process logs line by line

Use Case

The ndjson format is required for systems like VictoriaLogs and other log aggregation platforms that expect newline-delimited JSON format instead of standard JSON arrays.

Example

outputs:
 - name: http-receiver
   type: http
   http:
     url: 'https://victorialogs.example.com/insert/jsonline'
     format: ndjson

Testing

  • ✅ Vale check passed (0 errors, 0 warnings, 3 suggestions)
  • ✅ Field description clear and concise
  • ✅ Use case explained

Related

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

🤖 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/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Jul 1, 2026
@ocpdocs-previewbot

ocpdocs-previewbot commented Jul 1, 2026

Copy link
Copy Markdown

🤖 Fri Jul 03 18:55:39 - Prow CI generated the docs preview:

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

@JoaoBraveCoding JoaoBraveCoding 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.

This is more of a collection docs but /lgtm

@jcantrill jcantrill left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

/lgtm

@openshift-ci openshift-ci Bot added lgtm Indicates that a PR is ready to be merged. and removed lgtm Indicates that a PR is ready to be merged. labels Jul 2, 2026
@openshift-ci

openshift-ci Bot commented Jul 3, 2026

Copy link
Copy Markdown

New changes are detected. LGTM label has been removed.

@openshift-ci openshift-ci Bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Jul 3, 2026
Add format field to HTTP output configuration with json (default)
and ndjson options. Use ndjson for systems that expect newline-delimited
JSON format, such as VictoriaLogs.

Signed-off-by: John Wilkins <jowilkin@redhat.com>
@openshift-ci

openshift-ci Bot commented Jul 3, 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.

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/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants