docs: outputs: standard-output: add otlp_json and otlp_json_pretty format values#2530
Conversation
…rmat values
- pipeline/outputs/standard-output.md: add `otlp_json` and
`otlp_json_pretty` to the `format` parameter
This is a code change with no corresponding doc PR.
Signed-off-by: Eric D. Schabell <eric@schabell.org>
📝 WalkthroughWalkthroughDocumentation update to the Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
pipeline/outputs/standard-output.md (1)
13-13: Consider adding usage examples for the new OTLP formats.While not essential, adding example output for
otlp_jsonandotlp_json_prettyformats would help users understand the OTLP JSON structure. This would be particularly valuable since OTLP has a specific schema that differs from the standard JSON formats.📝 Example section that could be added
### OTLP JSON format example ```shell fluent-bit -i cpu -o stdout -p format=otlp_json_prettyThis outputs data in OpenTelemetry Protocol JSON format with pretty-printing for readability.
</details> <details> <summary>🤖 Prompt for AI Agents</summary>Verify each finding against the current code and only fix it if needed.
In
@pipeline/outputs/standard-output.mdat line 13, Add a short "OTLP JSON
format example" subsection to the documentation next to theformattable entry
showing how to invoke the stdout output withformat=otlp_jsonand
format=otlp_json_prettyand include a small representative OTLP JSON payload
(one compact and one pretty-printed example) so users can see the schema
differences; place this new subsection near theformatdescription and
reference theotlp_jsonandotlp_json_prettyvalues so readers can run the
sample command and compare compact vs pretty output.</details> </blockquote></details> </blockquote></details> <details> <summary>🤖 Prompt for all review comments with AI agents</summary>Verify each finding against the current code and only fix it if needed.
Inline comments:
In@pipeline/outputs/standard-output.md:
- Line 13: Update the supported formats list for the stdout plugin by removing
otlp_jsonandotlp_json_prettyfrom theformatdescription (the line
listing supported formats includingmsgpack,json,json_lines,
json_stream,otlp_json, andotlp_json_pretty), leaving onlymsgpack,
json,json_lines, andjson_stream; keep the default value asmsgpack
and, if necessary, add a brief note that OTLP JSON should be produced via the
OpenTelemetry/OTLP output plugin rather than the stdout plugin.
Nitpick comments:
In@pipeline/outputs/standard-output.md:
- Line 13: Add a short "OTLP JSON format example" subsection to the
documentation next to theformattable entry showing how to invoke the stdout
output withformat=otlp_jsonandformat=otlp_json_prettyand include a small
representative OTLP JSON payload (one compact and one pretty-printed example) so
users can see the schema differences; place this new subsection near the
formatdescription and reference theotlp_jsonandotlp_json_prettyvalues
so readers can run the sample command and compare compact vs pretty output.</details> <details> <summary>🪄 Autofix (Beta)</summary> Fix all unresolved CodeRabbit comments on this PR: - [ ] <!-- {"checkboxId": "4b0d0e0a-96d7-4f10-b296-3a18ea78f0b9"} --> Push a commit to this branch (recommended) - [ ] <!-- {"checkboxId": "ff5b1114-7d8c-49e6-8ac1-43f82af23a33"} --> Create a new PR with the fixes </details> --- <details> <summary>ℹ️ Review info</summary> <details> <summary>⚙️ Run configuration</summary> **Configuration used**: defaults **Review profile**: CHILL **Plan**: Pro **Run ID**: `a7ecd076-5b95-4dc9-8303-6b0f5cdc8851` </details> <details> <summary>📥 Commits</summary> Reviewing files that changed from the base of the PR and between d6f49c51efef08091f9ceac7ed7fdb1c00de7b9b and 53651c48821280fdaca9b03dd67411b35683b44c. </details> <details> <summary>📒 Files selected for processing (1)</summary> * `pipeline/outputs/standard-output.md` </details> </details> <!-- This is an auto-generated comment by CodeRabbit for review status -->
|
@patrick-stephens ready for review! |
|
Yeah this is the kind of thing it would be nice to have an automated check for in CI, i.e. if we add new options it flags them as missing. |
otlp_jsonandotlp_json_prettyto theformatparameterThis is a code change with no corresponding doc PR.
Summary by CodeRabbit
formatconfiguration parameter to reflect support for two new output formats:otlp_jsonandotlp_json_pretty. Default format remains unchanged.