interface FluentdLogDriverProps
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.ECS.FluentdLogDriverProps |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsecs#FluentdLogDriverProps |
![]() | software.amazon.awscdk.services.ecs.FluentdLogDriverProps |
![]() | aws_cdk.aws_ecs.FluentdLogDriverProps |
![]() | aws-cdk-lib » aws_ecs » FluentdLogDriverProps |
Specifies the fluentd log driver configuration options.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
const fluentdLogDriverProps: ecs.FluentdLogDriverProps = {
address: 'address',
asyncConnect: false,
bufferLimit: 123,
env: ['env'],
envRegex: 'envRegex',
labels: ['labels'],
maxRetries: 123,
retryWait: cdk.Duration.minutes(30),
subSecondPrecision: false,
tag: 'tag',
};
Properties
Name | Type | Description |
---|---|---|
address? | string | By default, the logging driver connects to localhost:24224. |
async | boolean | Docker connects to Fluentd in the background. |
buffer | number | The amount of data to buffer before flushing to disk. |
env? | string[] | The env option takes an array of keys. |
env | string | The env-regex option is similar to and compatible with env. |
labels? | string[] | The labels option takes an array of keys. |
max | number | The maximum number of retries. |
retry | Duration | How long to wait between retries. |
sub | boolean | Generates event logs in nanosecond resolution. |
tag? | string | By default, Docker uses the first 12 characters of the container ID to tag log messages. |
address?
Type:
string
(optional, default: address not set.)
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.
asyncConnect?
Type:
boolean
(optional, default: false)
Docker connects to Fluentd in the background.
Messages are buffered until the connection is established.
bufferLimit?
Type:
number
(optional, default: The amount of RAM available to the container.)
The amount of data to buffer before flushing to disk.
env?
Type:
string[]
(optional, default: 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.
envRegex?
Type:
string
(optional, default: 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.
labels?
Type:
string[]
(optional, default: 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.
maxRetries?
Type:
number
(optional, default: 4294967295 (232 - 1).)
The maximum number of retries.
retryWait?
Type:
Duration
(optional, default: 1 second)
How long to wait between retries.
subSecondPrecision?
Type:
boolean
(optional, default: false)
Generates event logs in nanosecond resolution.
tag?
Type:
string
(optional, default: The first 12 characters of the container ID)
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.