Skip to content

[docs-patrol] Update hybrid beat receiver docs for new defaults and supported beats #14113

@github-actions

Description

@github-actions

Recent code changes in the repository have introduced documentation drift. The following changes need corresponding documentation updates.

Changes Requiring Documentation Updates

1. Filebeat default runtime changed to otel, docs still state process

Commit(s):

What changed:

  • pkg/component/component.go now sets Filebeat default runtime to otel in DefaultRuntimeConfig() (Filebeat.Default: string(OtelRuntimeManager), around lines 66-69 in current main).

Documentation impact:

  • docs/hybrid-agent-beats-receivers.md still shows Filebeat default as process in the runtime example (filebeat.default: process, around lines 64-67).
  • This is now concretely incorrect and can mislead users about default execution mode.

2. Additional beat receivers are supported, docs still describe only Filebeat + Metricbeat

Commit(s):

What changed:

  • Runtime config support expanded in pkg/component/component.go (added auditbeat, heartbeat, osquerybeat, packetbeat runtime entries and selection handling).
  • Receiver factories added:
    • internal/edot/otelcol/components/default.go (abreceiver)
    • internal/edot/otelcol/components/components_nofips.go (hbreceiver, osqreceiver, pbreceiver)

Documentation impact:

  • docs/hybrid-agent-beats-receivers.md still states that only Filebeat and Metricbeat can run as receivers (around lines 46-48).
  • This omits newly supported receivers and leaves capability docs stale.

Suggested Actions

  • Update docs/hybrid-agent-beats-receivers.md to reflect Filebeat default runtime as otel (and adjust inline comments/examples accordingly).
  • Update the supported beat receiver list/capability section to include Auditbeat, Heartbeat, Osquerybeat, and Packetbeat where applicable.
  • Add a brief version qualifier or changelog note in that page so readers can map capability statements to release versions.

Note

🔒 Integrity filter blocked 37 items

The following items were blocked because they don't meet the GitHub integrity level.

  • #13960 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #12193 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #13337 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1726 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #10923 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #10421 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #8701 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #4125 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #4557 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #140 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #520 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #2690 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1724 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #4888 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #1193 search_issues: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • #13000 search_pull_requests: has lower integrity than agent requires. The agent cannot read data with integrity below "approved".
  • ... and 21 more items

To allow these resources, lower min-integrity in your GitHub frontmatter:

tools:
  github:
    min-integrity: approved  # merged | approved | unapproved | none

What is this? | From workflow: Docs Patrol

Give us feedback! React with 🚀 if perfect, 👍 if helpful, 👎 if not.

  • expires on May 15, 2026, 2:53 PM UTC

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions