Skip to content

YAML Config reserve attribute name for customer attributes #11683

@mp3monster

Description

@mp3monster

Is your feature request related to a problem? Please describe.
There are a variety of use cases where additional attributes in the Fluent Bit YAML file for the purposes of support processes where additional attributes would be helpful. For example, rather than have a separate file for an OpAMP supervisor, it would make life very easy if there were a config property prefix that could be simply ignored by Fluent Bit but considered valid within the configuration file.

This could also allow users to put config attributions into the file e.g.

  • metadata:
    usecase: 'monitor own Fluent Bit'
    configVersionNo: 12345

This sort of thing would also make it easy for a user to incorporate any annotations to the configuration that could be programmatically interogated

Describe the solution you'd like
Allow an attribute such as metadata to be accepted and validated as legal YAML within the configuration, but ignored by Fluent Bit itself so it has no material impact on Fluent Bit's operation. as illustrated above. Ideally, the config is checked for YAML compliance so it can be certain it is not adversely impacting the rest of the Fluent Bit setup.

Describe alternatives you've considered
Incorporate the information into comments - but this isn't pretty and prevents benefiting from any basic YAML validation processes.

Additional context
We're looking to achieve several goals:
As a minimum, track the configuration versions deployed by adding a version number tag which we can then populate on a precommit hook and/or during a deploy time consideration

ideally we can consolidate the configuration needed by an opamp supervisor within the Fluent Bit configuration file so that we don't need to maintain multiple files

By predefining a prefix for attributes, when the ocnfiguration is being processed into Fluentbit - the standard config handler knows to exclude these attributes operationally.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions