Fugue.AWS.ECS.LogConfiguration

Module Members

awslogs

(Function)

Setup the awslogs logging driver for Docker.

See https://docs.docker.com/engine/admin/logging/overview/#awslogs for full details.

Example usage:

awslogs: ECS.LogConfiguration.awslogs {
  awslogsRegion: AWS.Us-west-2,
  awslogsGroup: "myLogGroup",
  awslogsCreateGroup: True,
}

Type Signature

 fun { awslogsRegion: Optional<Region>,
       awslogsGroup: String,
       awslogsStream: Optional<String>,
       awslogsCreateGroup: Optional<Bool> } -> LogConfiguration
Argument: awslogsRegion
Type: Optional<Region>
Argument: awslogsGroup
Type: String
Argument: awslogsStream
Type: Optional<String>
Argument: awslogsCreateGroup
Type: Optional<Bool>
Returns:
Type: LogConfiguration

fluentd

(Function)

Setup the fluentd logging driver for Docker.

See https://docs.docker.com/engine/admin/logging/overview/#fluentd for full details.

Example usage:

fluentd: ECS.LogConfiguration.fluentd {
  fluentdAddress: "udp://192.168.0.42:12201",
}

Type Signature

 fun { fluentdAddress: Optional<String>,
       fluentdBufferLimit: Optional<String>,
       fluentdRetryWait: Optional<String>,
       fluentdMaxRetries: Optional<Int>,
       fluentdAsyncConnect: Optional<Bool>,
       tag: Optional<String> } -> LogConfiguration
Argument: fluentdAddress
Type: Optional<String>
Argument: fluentdBufferLimit
Type: Optional<String>
Argument: fluentdRetryWait
Type: Optional<String>
Argument: fluentdMaxRetries
Type: Optional<Int>
Argument: fluentdAsyncConnect
Type: Optional<Bool>
Argument: tag
Type: Optional<String>
Returns:
Type: LogConfiguration

gelf

(Function)

Setup the gelf logging driver for Docker.

See https://docs.docker.com/engine/admin/logging/overview/#gelf for full details.

Example usage:

gelf: ECS.LogConfiguration.gelf {
  gelfAddress: "udp://192.168.0.42:12201",
}

Type Signature

 fun { gelfAddress: Optional<String>,
       gelfCompressionType: Optional<String>,
       gelfCompressionLevel: Optional<Int>,
       tag: Optional<String> } -> LogConfiguration
Argument: gelfAddress
Type: Optional<String>
Argument: gelfCompressionType
Type: Optional<String>
Argument: gelfCompressionLevel
Type: Optional<Int>
Argument: tag
Type: Optional<String>
Returns:
Type: LogConfiguration

journald

(Function)

Setup the journald logging driver for Docker.

See https://docs.docker.com/engine/admin/logging/overview/#journald for full details.

Example usage:

journald: ECS.LogConfiguration.journald {}

Type Signature

 fun { tag: Optional<String> } -> LogConfiguration
Argument: tag
Type: Optional<String>
Returns:
Type: LogConfiguration

jsonFile

(Function)

Setup the json-file logging driver for Docker.

See https://docs.docker.com/engine/admin/logging/overview/#json-file for full details.

Example Usage:

jsonLogs: ECS.LogConfiguration.jsonFile {
  maxSize: "10m",
  maxFile: 3,
}

Type Signature

 fun { maxSize: Optional<String>,
       maxFile: Optional<Int> } -> LogConfiguration
Argument: maxSize

The maximum size of the log before it is rotated. Must be a positive integer with unit suffix (k, m, or g).

Type: Optional<String>

Argument: maxFile

The maximum number of log files to keep. The oldest files will be removed when rotating. Requires maxSize to be specified.

Type: Optional<Int>

Returns:

An LogConfiguration using the json-file logging driver.

Type: LogConfiguration

syslog

(Function)

Setup the syslog logging driver for Docker.

See https://docs.docker.com/engine/admin/logging/overview/#json-file for full details.

Example Usage:

syslog: ECS.LogConfiguration.syslog {
  syslogAddress: "tcp://192.168.0.42:123",
  syslogFacility: "daemon",
}

syslogWithTls: ECS.LogConfiguration.syslog {
  syslogAddress: "tcp+tls://192.168.0.42:123",
  syslogTlsCaCert: "/etc/ca-certificates/custom/ca.pem",
  syslogTlsCert: "/etc/ca-certificates/custom/cert.pem",
  syslogTlsKey: "/etc/ca-certificates/custom/key.pem",
}

Type Signature

 fun { syslogAddress: Optional<String>,
       syslogFacility: Optional<String>,
       syslogTlsCaCert: Optional<String>,
       syslogTlsCert: Optional<String>,
       syslogTlsKey: Optional<String>,
       syslogTlsSkipVerify: Optional<Bool>,
       tag: Optional<String>,
       syslogFormat: Optional<String> } -> LogConfiguration
Argument: syslogAddress
Type: Optional<String>
Argument: syslogFacility
Type: Optional<String>
Argument: syslogTlsCaCert
Type: Optional<String>
Argument: syslogTlsCert
Type: Optional<String>
Argument: syslogTlsKey
Type: Optional<String>
Argument: syslogTlsSkipVerify
Type: Optional<Bool>
Argument: tag
Type: Optional<String>
Argument: syslogFormat
Type: Optional<String>
Returns:
Type: LogConfiguration