LogConfiguration
The log configuration for the container. This parameter maps to LogConfig
in the Create a container--log-driver
option to
docker
run
By default, containers use the same logging driver that the Docker daemon uses;
however the container may use a different logging driver than the Docker daemon
by
specifying a log driver configuration in the container definition. For more information
on the options for different supported log drivers, see Configure logging
drivers
The following should be noted when specifying a log configuration for your containers:
-
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon (shown in the valid values below). Additional log drivers may be available in future releases of the Amazon ECS container agent.
-
This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
-
For tasks hosted on Amazon EC2 instances, the Amazon ECS container agent must register the available logging drivers with the
ECS_AVAILABLE_LOGGING_DRIVERS
environment variable before containers placed on that instance can use these log configuration options. For more information, see Amazon ECS container agent configuration in the Amazon Elastic Container Service Developer Guide. -
For tasks on AWS Fargate, because you do not have access to the underlying infrastructure your tasks are hosted on, any additional software needed will have to be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
Contents
- logDriver
-
The log driver to use for the container.
For tasks on AWS Fargate, the supported log drivers are
awslogs
,splunk
, andawsfirelens
.For tasks hosted on Amazon EC2 instances, the supported log drivers are
awslogs
,fluentd
,gelf
,json-file
,journald
,logentries
,syslog
,splunk
, andawsfirelens
.For more information about using the
awslogs
log driver, see Using the awslogs log driver in the Amazon Elastic Container Service Developer Guide.For more information about using the
awsfirelens
log driver, see Custom log routing in the Amazon Elastic Container Service Developer Guide.Note If you have a custom driver that is not listed, you can fork the Amazon ECS container agent project that is available on GitHub
and customize it to work with that driver. We encourage you to submit pull requests for changes that you would like to have included. However, we do not currently provide support for running modified copies of this software. Type: String
Valid Values:
json-file | syslog | journald | gelf | fluentd | awslogs | splunk | awsfirelens
Required: Yes
- options
-
The configuration options to send to the log driver. This parameter requires version 1.19 of the Docker Remote API or greater on your container instance. To check the Docker Remote API version on your container instance, log in to your container instance and run the following command:
sudo docker version --format '{{.Server.APIVersion}}'
Type: String to string map
Required: No
- secretOptions
-
The secrets to pass to the log configuration. For more information, see Specifying Sensitive Data in the Amazon Elastic Container Service Developer Guide.
Type: Array of Secret objects
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: