Fluentd Buffer Config Schema¶

Note

This is auto-generated documentation from a JSON schema that is under construction, this will improve over time.

https://raw.githubusercontent.com/elastisys/compliantkubernetes-apps/main/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:

Property	Type	Required	Nullable	Defined by
timekey	`string`	Optional	cannot be null	Welkin Apps Config
timekeyUseUtc	`boolean`	Optional	cannot be null	Welkin Apps Config
timekeyWait	`string`	Optional	cannot be null	Welkin Apps Config
chunkLimitSize	`string`	Optional	cannot be null	Welkin Apps Config
totalLimitSize	`string`	Optional	cannot be null	Welkin Apps Config
flushInterval	`string`	Optional	cannot be null	Welkin Apps Config
flushMode	`string`	Optional	cannot be null	Welkin Apps Config
flushThreadBurstInterval	`number`	Optional	cannot be null	Welkin Apps Config
flushThreadCount	`integer`	Optional	cannot be null	Welkin Apps Config
retryForever	`boolean`	Optional	cannot be null	Welkin Apps Config
retryType	`string`	Optional	cannot be null	Welkin Apps Config
retryMaxInterval	`integer`	Optional	cannot be null	Welkin Apps Config
Additional Properties	Merged	Optional	cannot be null	Welkin Apps Config

timekey¶

Output plugin will flush chunks per specified time (enabled when time is specified in chunk keys).

Common/Time parameters

timekey

is optional
Type: string (Time Key)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Time Key)

EXAMPLES:

10m

timekeyUseUtc¶

Output plugin decides to use UTC or not to format placeholders using timekey.

Common/Time parameters

timekeyUseUtc

is optional
Type: boolean (Timekey Use UTC)
cannot be null
defined in: Welkin 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.

Common/Time parameters

timekeyWait

is optional
Type: string (Timekey wait)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Timekey wait)

EXAMPLES:

1m

chunkLimitSize¶

Events will be written into chunks until the size of chunks become chunkLimitSize.

Buffering parameters

chunkLimitSize

is optional
Type: string (Chunk Limit Size)
cannot be null
defined in: Welkin 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).

Buffering parameters

totalLimitSize

is optional
Type: string (Total Limit Size)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Total Limit Size)

EXAMPLES:

9GB

flushInterval¶

Flushes the buffer each flushInterval, if flushMode is equal to interval.

Flushing parameters

flushInterval

is optional
Type: string (Flush Interval)
cannot be null
defined in: Welkin Apps Config

TYPE:

string (Flush Interval)

EXAMPLES:

15m

flushMode¶

The flush mode to use.

Flushing parameters

flushMode

is optional
Type: string (Flush Mode)
cannot be null
defined in: Welkin 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.

Flushing parameters

flushThreadBurstInterval

is optional
Type: number (Flush Thread Burst Interval)
cannot be null
defined in: Welkin Apps Config

TYPE:

number (Flush Thread Burst Interval)

flushThreadCount¶

The number of threads to flush/write chunks in parallel.

Flushing parameters

flushThreadCount

is optional
Type: integer (Flush Thread Count)
cannot be null
defined in: Welkin Apps Config

TYPE:

integer (Flush Thread Count)

retryForever¶

If true, plugin will ignore retryTimeout and retryMaxTimes options and retry flushing forever.

Retries parameters

retryForever

is optional
Type: boolean (Retry Forever)
cannot be null
defined in: Welkin Apps Config

TYPE:

boolean (Retry Forever)

retryType¶

The retry algorithm type to use.

Retries parameters

retryType

is optional
Type: string (Retry Type)
cannot be null
defined in: Welkin 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.

Retries parameters

retryMaxInterval

is optional
Type: integer (Retry Max Interval)
cannot be null
defined in: Welkin 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 or integer or boolean (Additional Properties)
cannot be null
defined in: Welkin Apps Config

TYPE:

any of the following: string or integer or boolean (Additional Properties)

not

Invalid Additional Properties Types

Return to the root config schema

Generated Thu Dec 19 03:51:01 UTC 2024 from elastisys/compliantkubernetes-apps@main