Skip to content

docs: document fireflyReceivers configuration option#50

Closed
ShawnMcKee with Copilot wants to merge 2 commits into
copilot/modify-fireflyp-pluginfrom
copilot/update-fireflyp-plugin-docs
Closed

docs: document fireflyReceivers configuration option#50
ShawnMcKee with Copilot wants to merge 2 commits into
copilot/modify-fireflyp-pluginfrom
copilot/update-fireflyp-plugin-docs

Conversation

Copilot AI commented Mar 2, 2026

Copy link
Copy Markdown
Contributor

PR #49 added fireflyReceivers to the fireflyp plugin but left the documentation unupdated. This PR adds the missing documentation across all three relevant files.

Changes

  • rpm/flowd-go.1.md — adds fireflyReceivers bullet under ## firefly in # PLUGINS, documenting the array-of-objects type, address/port sub-fields, and default behaviour
  • plugins/fireflyp/README.md — rewrites ## Configuration section: fixes stale backends: firefly: snippet to plugins: fireflyp:, adds missing bufferSize field, adds # fireflyReceivers: [] to the default config block, and adds a ### fireflyReceivers subsection with prose and a usage example
  • rpm/conf.yaml — adds commented-out fireflyReceivers block after hasSyslogHeader in the firefly plugin section

Example of the forwarding configuration:

plugins:
    fireflyp:
        fireflyReceivers:
          - address: "192.168.1.100"
            port: 10514
          - address: "accounting.example.org"
            port: 10514
Original prompt

Context

PR #49 (copilot/modify-fireflyp-plugin branch) adds a new fireflyReceivers configuration option to the fireflyp plugin. The new option allows the plugin to optionally forward received firefly datagrams verbatim to one or more UDP destinations (accounting receivers) before parsing.

The documentation has not been updated to reflect this new option. Three files need to be changed, all on the copilot/modify-fireflyp-plugin branch.


Files to Update

1. rpm/flowd-go.1.md — Man page

In the ## firefly section under # PLUGINS (currently lines 117–135), add a new bullet for fireflyReceivers after the existing hasSyslogHeader bullet:

- **fireflyReceivers [array of objects] {[]}**: An optional list of UDP destinations to which received firefly
  datagrams are forwarded verbatim before parsing. Each entry is an object with the following fields:

    - **address [string]**: The hostname or IP address of the destination.
    - **port [int]**: The UDP port of the destination. Must be equal to or lower than `65535`.

  When no receivers are configured (the default), the plugin behaves exactly as before. Configuring one or
  more receivers enables fan-out to accounting receivers without affecting normal flow-event processing.
  Example:

        fireflyReceivers:
          - address: "192.168.1.100"
            port: 10514
          - address: "accounting.example.org"
            port: 10514

2. plugins/fireflyp/README.md — Plugin README

The ## Configuration section (currently lines 167–178) shows the default configuration snippet but is missing fireflyReceivers. Update the section to:

  1. Add a prose description of fireflyReceivers before or after the YAML snippet.
  2. Update the YAML snippet to show the option (commented out or as a default empty list).

The updated ## Configuration section should look like:

## Configuration
Please refer to the Markdown-formatted documentation at the repository's root for more information on available
options. The following replicates the default configuration:

```yaml
plugins:
    fireflyp:
        bindAddress: "127.0.0.1"
        bindPort: 10514
        bufferSize: 4096
        deadline: 0
        hasSyslogHeader: false
        # fireflyReceivers: []

fireflyReceivers

An optional list of UDP destinations to forward received firefly datagrams to verbatim, before they are parsed
into flow events. Each entry requires an address (hostname or IP) and a port. Configuring zero receivers
(the default) preserves existing behaviour exactly. Example:

plugins:
    fireflyp:
        bindAddress: "0.0.0.0"
        bindPort: 10514
        fireflyReceivers:
          - address: "192.168.1.100"
            port: 10514
          - address: "accounting.example.org"
            port: 10514

### 3. `rpm/conf.yaml` — Sample configuration file

Under the `# # Create flowIDs based on incoming fireflies` / `# firefly:` block (currently around lines 36–49), add a commented-out block for `fireflyReceivers` after the `hasSyslogHeader` entry:

```yaml
    #     # Optionally forward received fireflies verbatim to one or more UDP
    #     # destinations before parsing. Each entry needs an address and a port.
    #     # fireflyReceivers:
    #     #   - address: "192.168.1.100"
    #     #     port: 10514

Summary of Changes

File Change
rpm/flowd-go.1.md Add fireflyReceivers bullet under ## firefly in # PLUGINS
plugins/fireflyp/README.md Update ## Configuration section to document fireflyReceivers
rpm/conf.yaml Add commented-out fireflyReceivers example in the firefly plugin block

All changes should be committed to the copilot/modify-fireflyp-plugin branch so they become part of PR #49.

This pull request was created from Copilot chat.


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

…le config

Co-authored-by: ShawnMcKee <3066214+ShawnMcKee@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation for fireflyReceivers configuration option docs: document fireflyReceivers configuration option Mar 2, 2026
@pcolladosoto

Copy link
Copy Markdown
Member

Superseded by #51

@pcolladosoto
pcolladosoto deleted the copilot/update-fireflyp-plugin-docs branch March 3, 2026 17:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants