Class: Aws::ECS::Types::LogConfiguration
- Inherits:
-
Struct
- Object
- Struct
- Aws::ECS::Types::LogConfiguration
- Defined in:
- gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb
Overview
The log configuration for the container. This parameter maps to
LogConfig
in the Create a container section of the Docker
Remote API and the --log-driver
option to docker run
.
By default, containers use the same logging driver that the Docker daemon uses. However, the container might use a different logging driver than the Docker daemon by specifying a log driver configuration in the container definition. For more information about the options for different supported log drivers, see Configure logging drivers in the Docker documentation.
Understand the following when specifying a log configuration for your containers.
Amazon ECS currently supports a subset of the logging drivers available to the Docker daemon. Additional log drivers may be available in future releases of the Amazon ECS container agent.
For tasks on 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
.This parameter requires version 1.18 of the Docker Remote API or greater on your container instance.
For tasks that are 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 that are on Fargate, because you don't have access to the underlying infrastructure your tasks are hosted on, any additional software needed must be installed outside of the task. For example, the Fluentd output aggregators or a remote host running Logstash to send Gelf logs to.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#log_driver ⇒ String
The log driver to use for the container.
-
#options ⇒ Hash<String,String>
The configuration options to send to the log driver.
-
#secret_options ⇒ Array<Types::Secret>
The secrets to pass to the log configuration.
Instance Attribute Details
#log_driver ⇒ String
The log driver to use for the container.
For tasks on Fargate, the supported log drivers are awslogs
,
splunk
, and awsfirelens
.
For tasks hosted on Amazon EC2 instances, the supported log drivers
are awslogs
, fluentd
, gelf
, json-file
, journald
,
logentries
,syslog
, splunk
, and awsfirelens
.
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.
6617 6618 6619 6620 6621 6622 6623 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6617 class LogConfiguration < Struct.new( :log_driver, :options, :secret_options) SENSITIVE = [] include Aws::Structure end |
#options ⇒ Hash<String,String>
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\}\}'
6617 6618 6619 6620 6621 6622 6623 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6617 class LogConfiguration < Struct.new( :log_driver, :options, :secret_options) SENSITIVE = [] include Aws::Structure end |
#secret_options ⇒ Array<Types::Secret>
The secrets to pass to the log configuration. For more information, see Specifying sensitive data in the Amazon Elastic Container Service Developer Guide.
6617 6618 6619 6620 6621 6622 6623 |
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 6617 class LogConfiguration < Struct.new( :log_driver, :options, :secret_options) SENSITIVE = [] include Aws::Structure end |