Skip to content

Add docs for resource out otel #2405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cb645j wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add docs for resource out otel #2405

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion pipeline/outputs/opentelemetry.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,8 @@ Only HTTP endpoints are supported.
| `logs_max_resources` | Set the maximum number of OTLP log resources per export request (`0` disables the limit). | `0` |
| `logs_max_scopes` | Set the maximum number of OTLP log scopes per resource (`0` disables the limit). | `0` |
| `logs_metadata_key` | Set the key to look up in the metadata. | `otlp` |
| `logs_resource_metadata_key` | Specify a `Resource` key. | `Resource` |
| `logs_resource_metadata_key` | Specify a `Resource` key. | `Resource`
| `logs_resource_attributes_message_key` | Specify a `Resource` key. | _none_ |
Copy link
Contributor

@coderabbitai coderabbitai bot Mar 2, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Clarify the new key’s purpose in the parameter table.

At Line 41, the description currently matches logs_resource_metadata_key semantics and is too vague. Please make it explicit that this is a message-field key promoted into Resource attributes.

Suggested doc wording 
-| `logs_resource_attributes_message_key`    | Specify a `Resource` key.                                                      | _none_                                                                      |
+| `logs_resource_attributes_message_key`    | Specify a message key whose value is added as a `Resource` attribute.          | _none_                                                                      |
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
| `logs_resource_attributes_message_key` | Specify a `Resource` key. | _none_ |
| `logs_resource_attributes_message_key` | Specify a message key whose value is added as a `Resource` attribute. | _none_ |
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@pipeline/outputs/opentelemetry.md` at line 41, Update the param table row for
logs_resource_attributes_message_key so its description clearly states that this
key names a message-field whose value will be promoted into the OpenTelemetry
Resource attributes (distinct from logs_resource_metadata_key which maps
metadata fields); replace the vague text with an explicit phrase like “Specify
the message field key whose value will be promoted into the Resource
attributes.”

Copy link
Collaborator

@eschabell eschabell Mar 3, 2026

Choose a reason for hiding this comment

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

@cb645j add a bit more clarity for each one in the description please.

Copy link
Contributor

@coderabbitai coderabbitai bot Mar 3, 2026

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

| `log_response_payload` | Specify if the response payload should be logged or not. | `true` |
| `logs_severity_number_message_key` | Specify a `SeverityNumber` key. | `$severityNumber` |
| `logs_severity_number_metadata_key` | Specify a `SeverityNumber` key. | `$SeverityNumber` |
Expand Down Expand Up @@ -135,6 +136,7 @@ pipeline:
logs_trace_id_message_key: trace_id
logs_severity_text_message_key: loglevel
logs_severity_number_message_key: lognum

Copy link
Contributor

@coderabbitai coderabbitai bot Mar 2, 2026 •
edited
Loading

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Keep YAML and classic config examples aligned.

The new option is shown in the fluent-bit.conf example but not in fluent-bit.yaml near Line 139. Please add the YAML equivalent so both examples demonstrate the same feature set.

Suggested YAML addition 
       logs_severity_text_message_key: loglevel
       logs_severity_number_message_key: lognum
+      logs_resource_attributes_message_key: application_id
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@pipeline/outputs/opentelemetry.md` at line 139, The fluent-bit.conf example
includes a new option that is missing from the fluent-bit.yaml example; update
the YAML example in pipeline/outputs/opentelemetry.md (the fluent-bit.yaml code
block around the current examples) to include the equivalent key/value entry so
both examples demonstrate the same feature set—locate the fluent-bit.conf block
to see the exact option name and value, then add the matching YAML mapping/key
under the fluent-bit.yaml section with the same semantic setting and a brief
inline comment mirroring the conf example.

Copy link
Collaborator

@eschabell eschabell Mar 3, 2026

Choose a reason for hiding this comment

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

@cb645j need to fix this one.

Copy link
Contributor

@coderabbitai coderabbitai bot Mar 3, 2026

Choose a reason for hiding this comment

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

Seems like the humans are having a chat. I'll hop back into my burrow for now. If you need me again, just tag @coderabbitai in a new comment, and I'll come hopping out!

# add user-defined labels
add_label:
- app fluent-bit
Expand Down Expand Up @@ -184,6 +186,8 @@ pipeline:
logs_trace_id_message_key trace_id
logs_severity_text_message_key loglevel
logs_severity_number_message_key lognum
logs_resource_attributes_message_key application_id
logs_resource_attributes_message_key service_name
# add user-defined labels
add_label app fluent-bit
add_label color blue
Expand Down