Class FluentdLogDriverProps

Specifies the fluentd log driver configuration options.

Inheritance

object

FluentdLogDriverProps

Implements

IFluentdLogDriverProps

IBaseLogDriverProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.ECS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class FluentdLogDriverProps : IFluentdLogDriverProps, IBaseLogDriverProps

Syntax (vb)

Public Class FluentdLogDriverProps Implements IFluentdLogDriverProps, IBaseLogDriverProps

Remarks

Source

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.ECS;

             var fluentdLogDriverProps = new FluentdLogDriverProps {
                 Address = "address",
                 Async = false,
                 AsyncConnect = false,
                 BufferLimit = 123,
                 Env = new [] { "env" },
                 EnvRegex = "envRegex",
                 Labels = new [] { "labels" },
                 MaxRetries = 123,
                 RetryWait = Duration.Minutes(30),
                 SubSecondPrecision = false,
                 Tag = "tag"
             };

Synopsis

Constructors

FluentdLogDriverProps()

Specifies the fluentd log driver configuration options.

Properties

Address	By default, the logging driver connects to localhost:24224.
Async	Docker connects to Fluentd in the background.
AsyncConnect	(deprecated) Docker connects to Fluentd in the background.
BufferLimit	The amount of data to buffer before flushing to disk.
Env	The env option takes an array of keys.
EnvRegex	The env-regex option is similar to and compatible with env.
Labels	The labels option takes an array of keys.
MaxRetries	The maximum number of retries.
RetryWait	How long to wait between retries.
SubSecondPrecision	Generates event logs in nanosecond resolution.
Tag	By default, Docker uses the first 12 characters of the container ID to tag log messages.

Constructors

FluentdLogDriverProps()

Specifies the fluentd log driver configuration options.

public FluentdLogDriverProps()

Remarks

Source

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK;
             using Amazon.CDK.AWS.ECS;

             var fluentdLogDriverProps = new FluentdLogDriverProps {
                 Address = "address",
                 Async = false,
                 AsyncConnect = false,
                 BufferLimit = 123,
                 Env = new [] { "env" },
                 EnvRegex = "envRegex",
                 Labels = new [] { "labels" },
                 MaxRetries = 123,
                 RetryWait = Duration.Minutes(30),
                 SubSecondPrecision = false,
                 Tag = "tag"
             };

Properties

Address

By default, the logging driver connects to localhost:24224.

public string? Address { get; set; }

Property Value

string

Remarks

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

Default: - address not set.

Async

Docker connects to Fluentd in the background.

public bool? Async { get; set; }

Property Value

bool?

Remarks

Messages are buffered until the connection is established.

Default: - false

AsyncConnect

(deprecated) Docker connects to Fluentd in the background.

[Obsolete("use `async` instead")]
public bool? AsyncConnect { get; set; }

Property Value

bool?

Remarks

Messages are buffered until the connection is established.

Default: - false

Stability: Deprecated

BufferLimit

The amount of data to buffer before flushing to disk.

public double? BufferLimit { get; set; }

Property Value

double?

Remarks

Default: - The amount of RAM available to the container.

Env

The env option takes an array of keys.

public string[]? Env { get; set; }

Property Value

string[]

Remarks

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

EnvRegex

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

public string? EnvRegex { get; set; }

Property Value

string

Remarks

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.

public string[]? Labels { get; set; }

Property Value

string[]

Remarks

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

MaxRetries

The maximum number of retries.

public double? MaxRetries { get; set; }

Property Value

double?

Remarks

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

RetryWait

How long to wait between retries.

public Duration? RetryWait { get; set; }

Property Value

Duration

Remarks

Default: - 1 second

SubSecondPrecision

Generates event logs in nanosecond resolution.

public bool? SubSecondPrecision { get; set; }

Property Value

bool?

Remarks

Default: - false

Tag

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

public string? Tag { get; set; }

Property Value

string

Remarks

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

Default: - The first 12 characters of the container ID

Implements

IFluentdLogDriverProps

IBaseLogDriverProps