Skip to content
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.

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

docs on buffer #1313

Closed
wants to merge 1 commit into from
Closed

docs on buffer #1313

wants to merge 1 commit into from

Conversation

genofire
Copy link
Collaborator

@genofire genofire commented Apr 23, 2023

i do not find the way the default values are setup.
but here is the documentation:
https://docs.fluentd.org/configuration/buffer-section

so maybe update that correctly based on then

@pepov
Copy link
Member

pepov commented Apr 27, 2023

Hey! Thanks you are right, that the definitions should reflect the actual state of the plugin, but there are a few things we have to consider:

  1. Backwards compatibility
    We need to consider if any of these changes mean a breaking change in existing deployments

  2. Using the plugin tag for setting defaults
    The plugin:"default:XY" tag should only be used in special situations. This is not very consistent throughout the code right now, but I would like to improve this.
    What the plugin:default tag does is it explicitly fills the value to something in the generated fluentd code. Now if that value is the same that fluentd would use if you would leave the field out, then what is the point of setting it?
    The point of the plugin:default is to set values that are different from what fluentd would set anyways. Of course we need to clearly articulate why this is needed.

In addition to this there are also other things we need to take care of, when making changes around buffer settings, see for example:
#1099
#732

I'm going to further comment on this PR soon, but for now I need to ask for your patience.

@stale
Copy link

stale bot commented Jun 26, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions!

@stale stale bot added the wontfix This will not be worked on label Jun 26, 2023
@stale stale bot closed this Jul 3, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
wontfix This will not be worked on
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants