GelfLogDriver

class aws_cdk.aws_ecs.GelfLogDriver(*, address, compression_level=None, compression_type=None, tcp_max_reconnect=None, tcp_reconnect_delay=None, env=None, env_regex=None, labels=None, tag=None)

Bases: LogDriver

A log driver that sends log information to journald Logs.

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

gelf_log_driver = ecs.GelfLogDriver(
    address="address",

    # the properties below are optional
    compression_level=123,
    compression_type=ecs.GelfCompressionType.GZIP,
    env=["env"],
    env_regex="envRegex",
    labels=["labels"],
    tag="tag",
    tcp_max_reconnect=123,
    tcp_reconnect_delay=cdk.Duration.minutes(30)
)

Constructs a new instance of the GelfLogDriver class.

Parameters:

• address (str) – The address of the GELF server. tcp and udp are the only supported URI specifier and you must specify the port.

• compression_level (Union[int, float, None]) – UDP Only The level of compression when gzip or zlib is the gelf-compression-type. An integer in the range of -1 to 9 (BestCompression). Higher levels provide more compression at lower speed. Either -1 or 0 disables compression. Default: - 1

• compression_type (Optional[GelfCompressionType]) – UDP Only The type of compression the GELF driver uses to compress each log message. Allowed values are gzip, zlib and none. Default: - gzip

• tcp_max_reconnect (Union[int, float, None]) – TCP Only The maximum number of reconnection attempts when the connection drop. A positive integer. Default: - 3

• tcp_reconnect_delay (Optional[Duration]) – TCP Only The number of seconds to wait between reconnection attempts. A positive integer. Default: - 1

• 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

Methods

bind(_scope, _container_definition)

Called when the log driver is configured on a container.

Parameters:

• _scope (Construct) –

• _container_definition (ContainerDefinition) –

Return type:

LogDriverConfig

Static Methods

classmethod aws_logs(*, stream_prefix, datetime_format=None, log_group=None, log_retention=None, mode=None, multiline_pattern=None)

Creates a log driver configuration that sends log information to CloudWatch Logs.

Parameters:

• stream_prefix (str) – Prefix for the log streams. The awslogs-stream-prefix option allows you to associate a log stream with the specified prefix, the container name, and the ID of the Amazon ECS task to which the container belongs. If you specify a prefix with this option, then the log stream takes the following format:: prefix-name/container-name/ecs-task-id

• datetime_format (Optional[str]) – This option defines a multiline start pattern in Python strftime format. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. Thus the matched line is the delimiter between log messages. Default: - No multiline matching.

• log_group (Optional[ILogGroup]) – The log group to log to. Default: - A log group is automatically created.

• log_retention (Optional[RetentionDays]) – The number of days log events are kept in CloudWatch Logs when the log group is automatically created by this construct. Default: - Logs never expire.

• mode (Optional[AwsLogDriverMode]) – The delivery mode of log messages from the container to awslogs. Default: - AwsLogDriverMode.BLOCKING

• multiline_pattern (Optional[str]) – This option defines a multiline start pattern using a regular expression. A log message consists of a line that matches the pattern and any following lines that don’t match the pattern. Thus the matched line is the delimiter between log messages. This option is ignored if datetimeFormat is also configured. Default: - No multiline matching.

Return type:

LogDriver