Skip to content

Commit

Permalink
Add AWS logs driver awslogs-create-stream option doc
Browse files Browse the repository at this point in the history
Signed-off-by: Austin Vazquez <[email protected]>
  • Loading branch information
austinvazquez committed Sep 18, 2024
1 parent c74c180 commit 7e01c26
Showing 1 changed file with 24 additions and 0 deletions.
24 changes: 24 additions & 0 deletions content/manuals/engine/logging/drivers/awslogs.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,30 @@ $ docker run \
> Your AWS IAM policy must include the `logs:CreateLogGroup` permission before
> you attempt to use `awslogs-create-group`.

### awslogs-create-stream

Check warning on line 130 in content/manuals/engine/logging/drivers/awslogs.md

View workflow job for this annotation

GitHub Actions / vale

[vale] reported by reviewdog 🐶 [Docker.HeadingSentenceCase] Use sentence case for headings: 'awslogs-create-stream'. Raw Output: {"message": "[Docker.HeadingSentenceCase] Use sentence case for headings: 'awslogs-create-stream'.", "location": {"path": "content/manuals/engine/logging/drivers/awslogs.md", "range": {"start": {"line": 130, "column": 5}}}, "severity": "WARNING"}

By default, the log driver will attempt to create the AWS CloudWatch Logs stream to be used
for container log persistence.

To disable AWS CloudWatch Logs stream creation, set `awslogs-create-stream` to `false`.

The `awslogs-create-stream` option defaults to `true`.

```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 aws-create-stream=false \
...
```

> [!NOTE]
>
> By disabling log stream creation, the Docker daemon assumes the log stream configured via
> `awslogs-stream` option or a log stream of the container ID (default) already exists.

### awslogs-datetime-format

The `awslogs-datetime-format` option defines a multi-line start pattern in [Python
Expand Down

0 comments on commit 7e01c26

Please sign in to comment.