Fluentd Buffer Config Schema¶
Note
This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.
Return to the root config schema
https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/v0.39.2/config/schemas/config.yaml#/properties/fluentd/properties/forwarder/properties/buffer
Fluentd buffer configuration parameters.
Note
See upstream documentation for reference, set keys will be converted from camelCase
to snake_case
.
Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
---|---|---|---|---|---|---|---|
Can be instantiated | No | Unknown status | No | Forbidden | Allowed | none | config/schemas/config.yaml* |
TYPE:
object
(Fluentd Buffer Config)
PROPERTIES:
timekey¶
Output plugin will flush chunks per specified time (enabled when time is specified in chunk keys).
timekey
-
is optional
-
Type:
string
(Time Key) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(Time Key)
EXAMPLES:
10m
timekeyUseUtc¶
Output plugin decides to use UTC or not to format placeholders using timekey.
timekeyUseUtc
-
is optional
-
Type:
boolean
(Timekey Use UTC) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean
(Timekey Use UTC)
timekeyWait¶
Output plugin will write chunks after timekey_wait seconds later after timekey expiration.
If a user configures timekey 60m, output plugin will wait delayed events for flushed timekey and write the chunk at 10 minutes of each hour.
timekeyWait
-
is optional
-
Type:
string
(Timekey wait) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(Timekey wait)
EXAMPLES:
1m
chunkLimitSize¶
Events will be written into chunks until the size of chunks become chunkLimitSize
.
chunkLimitSize
-
is optional
-
Type:
string
(Chunk Limit Size) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(Chunk Limit Size)
EXAMPLES:
50MB
totalLimitSize¶
The size limitation of this buffer plugin instance.
Once the total size of stored buffer reached this threshold, all append operations will fail with error (and data will be lost).
totalLimitSize
-
is optional
-
Type:
string
(Total Limit Size) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(Total Limit Size)
EXAMPLES:
9GB
flushInterval¶
Flushes the buffer each flushInterval
, if flushMode
is equal to interval
.
flushInterval
-
is optional
-
Type:
string
(Flush Interval) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(Flush Interval)
EXAMPLES:
15m
flushMode¶
The flush mode to use.
flushMode
-
is optional
-
Type:
string
(Flush Mode) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(Flush Mode)
CONSTRAINTS:
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"lazy" |
Flushes/writes chunks once per timekey |
"interval" |
Flushes/writes chunks per specified time via flushInterval |
"immediate" |
Flushes/writes chunks immediately after events are appended into chunks |
flushThreadBurstInterval¶
The sleep interval (seconds) for threads between flushes when the output plugin flushes the waiting chunks to the next ones.
flushThreadBurstInterval
-
is optional
-
Type:
number
(Flush Thread Burst Interval) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
number
(Flush Thread Burst Interval)
flushThreadCount¶
The number of threads to flush/write chunks in parallel.
flushThreadCount
-
is optional
-
Type:
integer
(Flush Thread Count) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
integer
(Flush Thread Count)
retryForever¶
If true, plugin will ignore retryTimeout
and retryMaxTimes
options and retry flushing forever.
retryForever
-
is optional
-
Type:
boolean
(Retry Forever) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
boolean
(Retry Forever)
retryType¶
The retry algorithm type to use.
retryType
-
is optional
-
Type:
string
(Retry Type) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
string
(Retry Type)
CONSTRAINTS:
enum: the value of this property must be equal to one of the following values:
Value | Explanation |
---|---|
"exponential_backoff" |
Increase the wait time, in seconds, exponentially per failure |
"periodic" |
Output plugin will retry periodically with fixed intervals (configured via retryWait) |
retryMaxInterval¶
The maximum interval (seconds) for exponential backoff between retries while failing.
retryMaxInterval
-
is optional
-
Type:
integer
(Retry Max Interval) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
integer
(Retry Max Interval)
PROPERTIES:
Additional properties are allowed, as long as they follow this schema:
Additional properties
Assuming that these are never structures, only scalars
-
is optional
-
Type: any of the following:
string
orinteger
orboolean
(Additional Properties) -
cannot be null
-
defined in: Compliant Kubernetes Apps Config
TYPE:
any of the following: string
or integer
or boolean
(Additional Properties)
not
Return to the root config schema
Generated Thu Nov 14 16:14:40 UTC 2024 from elastisys/compliantkubernetes-apps@v0.39.2