ServiceConnectAccessLogConfiguration

class aws_cdk.aws_ecs.ServiceConnectAccessLogConfiguration(*, format, include_query_parameters=None)

Bases: object

Configuration for Service Connect access logs.

Service Connect access logs provide detailed telemetry about individual requests processed by the Service Connect proxy, including HTTP methods, paths, response codes, and timing information.

Parameters:

format (ServiceConnectAccessLogFormat) – The format for Service Connect access log output. - TEXT: Human-readable text format - JSON: Structured JSON format for log analysis tools
include_query_parameters (Optional[bool]) – Whether to include query parameters in Service Connect access logs. When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications as query parameters may contain sensitive information such as request IDs and tokens. Default: undefined - AWS ECS default is false, which means that query parameters are not included in access logs

See:

https://docs.aws.amazon.com/AmazonECS/latest/developerguide/service-connect-envoy-access-logs.html

ExampleMetadata:

infused

Example:

# cluster: ecs.Cluster
# task_definition: ecs.TaskDefinition


service = ecs.FargateService(self, "Service",
    cluster=cluster,
    task_definition=task_definition,
    service_connect_configuration=ecs.ServiceConnectProps(
        services=[ecs.ServiceConnectService(
            port_mapping_name="api"
        )
        ],
        access_log_configuration=ecs.ServiceConnectAccessLogConfiguration(
            format=ecs.ServiceConnectAccessLogFormat.JSON,
            include_query_parameters=True
        ),
        # When configuring access log,
        # you also need to configure the log driver accordingly.
        log_driver=ecs.LogDrivers.aws_logs(
            stream_prefix="prefix"
        )
    )
)

Attributes

format

The format for Service Connect access log output.

TEXT: Human-readable text format
JSON: Structured JSON format for log analysis tools

include_query_parameters

Whether to include query parameters in Service Connect access logs.

When enabled, query parameters from HTTP requests are included in the access logs. Consider security and privacy implications as query parameters may contain sensitive information such as request IDs and tokens.

Default:: undefined - AWS ECS default is false, which means that query parameters are not included in access logs