Skip to content

Backport(v1.19): buffer: warn if default timekey (1d) will be used (#5276)#5291

Open
github-actions[bot] wants to merge 1 commit intov1.19from
backport-to-v1.19/pr5276
Open

Backport(v1.19): buffer: warn if default timekey (1d) will be used (#5276)#5291
github-actions[bot] wants to merge 1 commit intov1.19from
backport-to-v1.19/pr5276

Conversation

@github-actions
Copy link

Which issue(s) this PR fixes:
Backport #5276
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

**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

Signed-off-by: Kentaro Hayashi <hayashi@clear-code.com>
Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.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