From 42c6ba392efc47da16b94a113b76356be5cbdb4a Mon Sep 17 00:00:00 2001 From: Austin Vazquez Date: Wed, 18 Sep 2024 15:41:15 +0000 Subject: [PATCH] Add AWS logs driver awslogs-create-stream option doc Signed-off-by: Austin Vazquez --- .../manuals/engine/logging/drivers/awslogs.md | 21 +++++++++++++++++++ 1 file changed, 21 insertions(+) diff --git a/content/manuals/engine/logging/drivers/awslogs.md b/content/manuals/engine/logging/drivers/awslogs.md index 42cdb8f55e94..1d74abae2fe9 100644 --- a/content/manuals/engine/logging/drivers/awslogs.md +++ b/content/manuals/engine/logging/drivers/awslogs.md @@ -127,6 +127,27 @@ $ docker run \ > Your AWS IAM policy must include the `logs:CreateLogGroup` permission before > you attempt to use `awslogs-create-group`. +### awslogs-create-stream + +By default, the log driver will create the AWS CloudWatch Logs stream used for container log persistence. + +Set `awslogs-create-stream` to `false` to disable log stream creation. When disabled, the Docker daemon assumes +the log stream already exists. A use case where this is beneficial is when log stream creation is handled by +another process thus avoiding redundant AWS CloudWatch Logs create stream API calls. + +If disabled and log stream does not exist, then log persistence to CloudWatch will fail during container run time +with `Failed to put log events` error messages in daemon logs. + +```console +$ docker run \ + --log-driver=awslogs \ + --log-opt awslogs-region=us-east-1 \ + --log-opt awslogs-group=myLogGroup \ + --log-opt awslogs-stream=myLogStream \ + --log-opt awslogs-create-stream=false \ + ... +``` + ### awslogs-datetime-format The `awslogs-datetime-format` option defines a multi-line start pattern in [Python