Show / Hide Table of Contents

Interface IGelfLogDriverProps

Specifies the journald log driver configuration options.

Inherited Members
IBaseLogDriverProps.Env
IBaseLogDriverProps.EnvRegex
IBaseLogDriverProps.Labels
IBaseLogDriverProps.Tag
Namespace: Amazon.CDK.AWS.ECS
Assembly: Amazon.CDK.AWS.ECS.dll
Syntax (csharp)
public interface IGelfLogDriverProps : IBaseLogDriverProps
Syntax (vb)
Public Interface IGelfLogDriverProps
    Inherits IBaseLogDriverProps
Remarks

Source

ExampleMetadata: infused

Examples
// Create a Task Definition for the container to start
var taskDefinition = new Ec2TaskDefinition(this, "TaskDef");
taskDefinition.AddContainer("TheContainer", new ContainerDefinitionOptions {
    Image = ContainerImage.FromRegistry("example-image"),
    MemoryLimitMiB = 256,
    Logging = LogDrivers.Gelf(new GelfLogDriverProps { Address = "my-gelf-address" })
});

Synopsis

Properties

Address

The address of the GELF server.

CompressionLevel

UDP Only The level of compression when gzip or zlib is the gelf-compression-type.

CompressionType

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

TcpMaxReconnect

TCP Only The maximum number of reconnection attempts when the connection drop.

TcpReconnectDelay

TCP Only The number of seconds to wait between reconnection attempts.

Properties

Address

The address of the GELF server.

string Address { get; }
Property Value

System.String

Remarks

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

CompressionLevel

UDP Only The level of compression when gzip or zlib is the gelf-compression-type.

virtual Nullable<double> CompressionLevel { get; }
Property Value

System.Nullable<System.Double>

Remarks

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

CompressionType

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

virtual Nullable<GelfCompressionType> CompressionType { get; }
Property Value

System.Nullable<GelfCompressionType>

Remarks

Allowed values are gzip, zlib and none.

Default: - gzip

TcpMaxReconnect

TCP Only The maximum number of reconnection attempts when the connection drop.

virtual Nullable<double> TcpMaxReconnect { get; }
Property Value

System.Nullable<System.Double>

Remarks

A positive integer.

Default: - 3

TcpReconnectDelay

TCP Only The number of seconds to wait between reconnection attempts.

virtual Duration TcpReconnectDelay { get; }
Property Value

Duration

Remarks

A positive integer.

Default: - 1

Back to top Generated by DocFX