Skip to content

buffer: warn if default timekey (1d) will be used#5276

Open
kenhys wants to merge 1 commit intofluent:masterfrom
kenhys:warn-default-buffer-timekey
Open

buffer: warn if default timekey (1d) will be used#5276
kenhys wants to merge 1 commit intofluent:masterfrom
kenhys:warn-default-buffer-timekey

Conversation

@kenhys
Copy link
Contributor

@kenhys kenhys commented Mar 12, 2026

Which issue(s) this PR fixes:
Fixes #

What this PR does / why we need it:

By default, the value of timekey interval was set as interval 1d. Without changing flush related parameters, it will not be flushed at all in that period. This behavior is intentional design, but it might be surprised in some use cases.

So, in some doubtful use-case, emit warning for it.

Before:

  no buffer configuration # no warning

  <buffer>
    @type file # no warning
  </buffer>

  <buffer time>
    @type file # no warning
  </buffer>

  <buffer []>
    @type file # no warning
  </buffer>

After:

  no buffer configuration # warning

  <buffer>
    @type file # warning
  </buffer>

  <buffer time>
    @type file # warning
  </buffer>

  <buffer []>
    @type file # no warning
  </buffer>

Docs Changes:

N/A

Release Note:

N/A

By default, the value of timekey interval was set as interval
1d. Without changing flush related parameters, it will not be flushed
at all in that period. This behavior is intentional design, but it
might be surprised in some use cases.

So, in some doubtful use-case, emit warning for it.

Before:

  no buffer configuration # no warning

  <buffer>
    @type file # no warning
  </buffer>

  <buffer time>
    @type file # no warning
  </buffer>

  <buffer []>
    @type file # no warning
  </buffer>

After:

  no buffer configuration # warning

  <buffer>
    @type file # warning
  </buffer>

  <buffer time>
    @type file # warning
  </buffer>

  <buffer []>
    @type file # no warning
  </buffer>

Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
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.

1 participant