FluentdLogDriverProps

class aws_cdk.aws_ecs.FluentdLogDriverProps(*, env=None, env_regex=None, labels=None, tag=None, address=None, async_connect=None, buffer_limit=None, max_retries=None, retry_wait=None, sub_second_precision=None)

Bases: BaseLogDriverProps

Specifies the fluentd log driver configuration options.

Source

Parameters
  • env (Optional[Sequence[str]]) – The env option takes an array of keys. If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message. Default: - No env

  • env_regex (Optional[str]) – The env-regex option is similar to and compatible with env. Its value is a regular expression to match logging-related environment variables. It is used for advanced log tag options. Default: - No envRegex

  • labels (Optional[Sequence[str]]) – The labels option takes an array of keys. If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message. Default: - No labels

  • tag (Optional[str]) – By default, Docker uses the first 12 characters of the container ID to tag log messages. Refer to the log tag option documentation for customizing the log tag format. Default: - The first 12 characters of the container ID

  • address (Optional[str]) – By default, the logging driver connects to localhost:24224. Supply the address option to connect to a different address. tcp(default) and unix sockets are supported. Default: - address not set.

  • async_connect (Optional[bool]) – Docker connects to Fluentd in the background. Messages are buffered until the connection is established. Default: - false

  • buffer_limit (Union[int, float, None]) – The amount of data to buffer before flushing to disk. Default: - The amount of RAM available to the container.

  • max_retries (Union[int, float, None]) – The maximum number of retries. Default: - 4294967295 (2**32 - 1).

  • retry_wait (Optional[Duration]) – How long to wait between retries. Default: - 1 second

  • sub_second_precision (Optional[bool]) – Generates event logs in nanosecond resolution. Default: - false

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_ecs as ecs
import aws_cdk.core as cdk

fluentd_log_driver_props = ecs.FluentdLogDriverProps(
    address="address",
    async_connect=False,
    buffer_limit=123,
    env=["env"],
    env_regex="envRegex",
    labels=["labels"],
    max_retries=123,
    retry_wait=cdk.Duration.minutes(30),
    sub_second_precision=False,
    tag="tag"
)

Attributes

address

Supply the address option to connect to a different address. tcp(default) and unix sockets are supported.

Default
  • address not set.

Type

By default, the logging driver connects to localhost

async_connect

Docker connects to Fluentd in the background.

Messages are buffered until the connection is established.

Default
  • false

buffer_limit

The amount of data to buffer before flushing to disk.

Default
  • The amount of RAM available to the container.

env

The env option takes an array of keys.

If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

Default
  • No env

env_regex

The env-regex option is similar to and compatible with env.

Its value is a regular expression to match logging-related environment variables. It is used for advanced log tag options.

Default
  • No envRegex

labels

The labels option takes an array of keys.

If there is collision between label and env keys, the value of the env takes precedence. Adds additional fields to the extra attributes of a logging message.

Default
  • No labels

max_retries

The maximum number of retries.

Default
  • 4294967295 (2**32 - 1).

retry_wait

How long to wait between retries.

Default
  • 1 second

sub_second_precision

Generates event logs in nanosecond resolution.

Default
  • false

tag

By default, Docker uses the first 12 characters of the container ID to tag log messages.

Refer to the log tag option documentation for customizing the log tag format.

Default
  • The first 12 characters of the container ID