Skip to content

docs: pipeline: inputs: ebpf: document OpenSSL trace and event_id field#2615

Merged
patrick-stephens merged 1 commit into
fluent:masterfrom
eschabell:erics_in_ebpf_updates
Jul 10, 2026
Merged

docs: pipeline: inputs: ebpf: document OpenSSL trace and event_id field#2615
patrick-stephens merged 1 commit into
fluent:masterfrom
eschabell:erics_in_ebpf_updates

Conversation

@eschabell

@eschabell eschabell commented Jul 7, 2026

Copy link
Copy Markdown
Collaborator
  • Document the trace_openssl trace, including the openssl_tls_read, openssl_tls_write, openssl_tls_shutdown, and openssl_tls_handshake operations and their ssl_ptr, latency_ns, and ret fields.
  • Add trace_openssl to the trace parameter list and the tls_* values to the event_type field.
  • Document the new per-CPU monotonic event_id common field emitted on every trace record.

Note this update due to code change without matching docs PR.

Summary by CodeRabbit

  • Documentation
    • Added documentation for a new trace configuration option, including its repeatable behavior and default value.
    • Expanded supported event type descriptions to include additional TLS-related event types.
    • Added a new section describing extra fields available for OpenSSL trace events.

  - Document the trace_openssl trace, including the openssl_tls_read,
    openssl_tls_write, openssl_tls_shutdown, and openssl_tls_handshake
    operations and their ssl_ptr, latency_ns, and ret fields.
  - Add trace_openssl to the trace parameter list and the tls_* values
    to the event_type field.
  - Document the new per-CPU monotonic event_id common field emitted
    on every trace record.

Note this update due to code change without matching docs PR.

Signed-off-by: Eric D. Schabell <eric@schabell.org>
@eschabell eschabell self-assigned this Jul 7, 2026
@eschabell eschabell requested a review from a team as a code owner July 7, 2026 21:23
@eschabell eschabell added waiting-on-review Waiting on a review from mainteners 5.0.9 labels Jul 7, 2026
@coderabbitai

coderabbitai Bot commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 47c51578-1baf-468d-9749-2eb9a01d5dbc

📥 Commits

Reviewing files that changed from the base of the PR and between 8892466 and 5482287.

📒 Files selected for processing (1)
  • pipeline/inputs/ebpf.md

📝 Walkthrough

Walkthrough

Documentation update to pipeline/inputs/ebpf.md adding the trace configuration parameter, expanding the event_type common field description with TLS-related event types, and introducing a new "OpenSSL trace fields" section describing trace_openssl fields.

Changes

eBPF documentation updates

Layer / File(s) Summary
Trace parameter and TLS event type documentation
pipeline/inputs/ebpf.md
Adds the trace configuration parameter row and expands event_type to include TLS-related event type strings.
OpenSSL trace fields section
pipeline/inputs/ebpf.md
Adds a new "OpenSSL trace fields" subsection documenting trace, ssl_ptr, latency_ns, and ret fields for trace_openssl.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Possibly related PRs

  • fluent/fluent-bit-docs#2240: Both PRs update pipeline/inputs/ebpf.md adding/expanding trace configuration and documenting trace-specific output fields in the same sections.
  • fluent/fluent-bit-docs#2534: Both PRs extend trace/event_type documentation and add trace-specific field sections in the same file.
  • fluent/fluent-bit-docs#2571: Both PRs extend in_ebpf trace/event_type documentation and add new trace-specific field sections.

Suggested reviewers: patrick-stephens, cosmo0920

🚥 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 summarizes the main documentation update: OpenSSL trace support and the new event_id field.
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.
✨ 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

Comment @coderabbitai help to get the list of available commands.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Jul 8, 2026

Copy link
Copy Markdown
Contributor
✅ Action performed

Review finished.

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.

@eschabell

Copy link
Copy Markdown
Collaborator Author

@patrick-stephens ready for review!

@patrick-stephens patrick-stephens merged commit c8a71c4 into fluent:master Jul 10, 2026
8 checks passed
@eschabell eschabell added 5.0.8 and removed waiting-on-review Waiting on a review from mainteners 5.0.8 labels Jul 10, 2026
@eschabell eschabell deleted the erics_in_ebpf_updates branch July 10, 2026 10:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants