AWS CDK Reference

Appearance

v2.273.0

GelfLogDriverProps Struct ​

Specifies the journald log driver configuration options.

Source

Source
aws-ecs/lib/log-drivers/gelf-log-driver.ts

Example ​

ts
// Create a Task Definition for the container to start
const taskDefinition = new ecs.Ec2TaskDefinition(this, 'TaskDef');
taskDefinition.addContainer('TheContainer', {
  image: ecs.ContainerImage.fromRegistry('example-image'),
  memoryLimitMiB: 256,
  logging: ecs.LogDrivers.gelf({ address: 'my-gelf-address' }),
});

Properties ​

addressstringaddressstraddressStringAddressstringAddress*stringrequired#
The address of the GELF server.

tcp and udp are the only supported URI specifier and you must specify the port.

compressionLevelnumbercompression_levelint | floatcompressionLevelNumberCompressionLeveldoubleCompressionLevel*float64= 1#
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.

compressionTypeGelfCompressionTypecompression_typeGelfCompressionTypecompressionTypeGelfCompressionTypeCompressionTypeGelfCompressionTypeCompressionTypeGelfCompressionType= gzip#
UDP Only The type of compression the GELF driver uses to compress each log message.

Allowed values are gzip, zlib and none.

envstring[]envtyping.List[str]envList<String>Envstring[]Env*[]*string= No 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.

envRegexstringenv_regexstrenvRegexStringEnvRegexstringEnvRegex*string= No envRegex#
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.

labelsstring[]labelstyping.List[str]labelsList<String>Labelsstring[]Labels*[]*string= No 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.

tagstringtagstrtagStringTagstringTag*string= The first 12 characters of the c…#
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

Default: The first 12 characters of the container ID

tcpMaxReconnectnumbertcp_max_reconnectint | floattcpMaxReconnectNumberTcpMaxReconnectdoubleTcpMaxReconnect*float64= 3#
TCP Only The maximum number of reconnection attempts when the connection drop.

A positive integer.

tcpReconnectDelayDurationtcp_reconnect_delayDurationtcpReconnectDelayDurationTcpReconnectDelayDurationTcpReconnectDelayDuration= 1#
TCP Only The number of seconds to wait between reconnection attempts.

A positive integer.

Used as props by ​