docs: outputs: s3: document format parameter for OTLP JSON output

[eschabell]

• add a format configuration parameter documenting json_lines (default) and otlp_json values, and noting that log_key isn't supported when format is otlp_json

Note this is a fix for code changes without corresponding docs PR

Summary by CodeRabbit

• Documentation
  • Added documentation for the format configuration parameter for Amazon S3 output, including supported values (json_lines, otlp_json), default settings, and related constraints.

[coderabbitai]

📝 Walkthrough

Walkthrough

This PR adds a documentation entry for the format configuration parameter in the Amazon S3 output plugin. The parameter supports json_lines (default) and otlp_json formats, with a constraint that log_key is not applicable when using otlp_json.

Changes

S3 Output Format Parameter Documentation

Layer / File(s)	Summary
Format parameter configuration documentation pipeline/outputs/s3.md	Configuration table row documents the format parameter with supported values (json_lines, otlp_json), default value, and constraint that log_key is unsupported when format is otlp_json.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Suggested labels

5.0

Suggested reviewers

• patrick-stephens

Poem

🐰 A format parameter lands with grace,
In S3 docs, a tidy place,
JSON lines or OTLP may flow,
Configuration constraints we now know! ✨

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly and specifically documents the primary change: adding documentation for the format parameter in S3 output with focus on OTLP JSON support.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[eschabell]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

pipeline/outputs/s3.md (1)

54-54: ⚡ Quick win

Consider adding an example configuration demonstrating OTLP JSON format usage.

Since this introduces a new format option for OTLP JSON output, adding an example configuration section would help users understand how to use this feature, especially given the constraint that log_key is not supported in this mode.

📋 Example configuration suggestion

You could add a new example section (perhaps after the "Get started" section or within it) demonstrating OTLP JSON format usage:

# Example: Using OTLP JSON format
pipeline:
  outputs:
    - name: s3
      match: '*'
      bucket: your-bucket
      region: us-east-1
      format: otlp_json
      store_dir: /home/ec2-user/buffer
      total_file_size: 50M
      upload_timeout: 10m

🤖 Prompt for AI Agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@pipeline/outputs/s3.md` at line 54, Add a short example configuration showing
how to use the new otlp_json format for the S3 output: include the outputs block
with name: s3, match, bucket, region, format: otlp_json, and relevant required
fields such as store_dir, total_file_size, and upload_timeout, and mention that
log_key is not supported when format is otlp_json; reference the existing
`format`, `otlp_json`, `log_key`, and `outputs` symbols so the example is placed
near the S3 output docs.

🤖 Prompt for all review comments with AI agents

Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pipeline/outputs/s3.md`:
- Line 54: Update the `format` table entry to explicitly state the runtime
behavior when `format` is set to `otlp_json`: mention that only `logs` event
chunks are converted to OTLP JSON and that non-logs event chunks (e.g.,
`metrics`, `traces`) are not converted and are dropped/ignored (or, if your
implementation emits a warning or error, state that instead); also keep the note
that `log_key` is not supported with `otlp_json` and add a short recommendation
to emit a warning or surface an error if non-logs chunks are received so users
aren’t surprised.

---

Nitpick comments:
In `@pipeline/outputs/s3.md`:
- Line 54: Add a short example configuration showing how to use the new
otlp_json format for the S3 output: include the outputs block with name: s3,
match, bucket, region, format: otlp_json, and relevant required fields such as
store_dir, total_file_size, and upload_timeout, and mention that log_key is not
supported when format is otlp_json; reference the existing `format`,
`otlp_json`, `log_key`, and `outputs` symbols so the example is placed near the
S3 output docs.

🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

• Push a commit to this branch (recommended)
• Create a new PR with the fixes

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c8ae58d2-6868-40c1-bc55-a3e41bfe0650

📥 Commits

Reviewing files that changed from the base of the PR and between bf3e17c and 0f10fca.

📒 Files selected for processing (1)

• pipeline/outputs/s3.md