Class FluentdLogDriverProps
Specifies the fluentd log driver configuration options.
Inheritance
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public class FluentdLogDriverProps : Object, IFluentdLogDriverProps, IBaseLogDriverProps
Syntax (vb)
Public Class FluentdLogDriverProps
Inherits Object
Implements IFluentdLogDriverProps, IBaseLogDriverProps
Remarks
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.AWS.ECS;
using Amazon.CDK;
var fluentdLogDriverProps = new FluentdLogDriverProps {
Address = "address",
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() |
Properties
Address | By default, the logging driver connects to localhost:24224. |
AsyncConnect | 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()
public FluentdLogDriverProps()
Properties
Address
By default, the logging driver connects to localhost:24224.
public string Address { get; set; }
Property Value
System.String
Remarks
Supply the address option to connect to a different address. tcp(default) and unix sockets are supported.
Default: - address not set.
AsyncConnect
Docker connects to Fluentd in the background.
public Nullable<bool> AsyncConnect { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Messages are buffered until the connection is established.
Default: - false
BufferLimit
The amount of data to buffer before flushing to disk.
public Nullable<double> BufferLimit { get; set; }
Property Value
System.Nullable<System.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
System.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
System.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
System.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 Nullable<double> MaxRetries { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 4294967295 (2**32 - 1).
RetryWait
How long to wait between retries.
public Duration RetryWait { get; set; }
Property Value
Remarks
Default: - 1 second
SubSecondPrecision
Generates event logs in nanosecond resolution.
public Nullable<bool> SubSecondPrecision { get; set; }
Property Value
System.Nullable<System.Boolean>
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
System.String
Remarks
Refer to the log tag option documentation for customizing the log tag format.
Default: - The first 12 characters of the container ID