Skip to content

Commit 84175ad

Browse files
authored
docs: add doc for logging (#2578)
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
1 parent 4a347b8 commit 84175ad

File tree

2 files changed

+42
-0
lines changed

2 files changed

+42
-0
lines changed

site/content/docs/include/common-svc-fields.en.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -215,5 +215,25 @@ Optional. Defaults to `""`. The ID of the EFS access point to connect to. If usi
215215

216216
<div class="separator"></div>
217217

218+
<a id="logging" href="#logging" class="field">`logging`</a> <span class="type">Map</span>
219+
The logging section contains log configuration parameters for your container's [FireLens](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) log driver (see examples [here](../developing/sidecars.en.md#sidecar-patterns)).
220+
221+
<span class="parent-field">logging.</span><a id="logging-image" href="#logging-image" class="field">`image`</a> <span class="type">Map</span>
222+
Optional. The Fluent Bit image to use. Defaults to `amazon/aws-for-fluent-bit:latest`.
223+
224+
<span class="parent-field">logging.</span><a id="logging-destination" href="#logging-destination" class="field">`destination`</a> <span class="type">Map</span>
225+
Optional. The configuration options to send to the FireLens log driver.
226+
227+
<span class="parent-field">logging.</span><a id="logging-enableMetadata" href="#logging-enableMetadata" class="field">`enableMetadata`</a> <span class="type">Map</span>
228+
Optional. Whether to include ECS metadata in logs. Defaults to `true`.
229+
230+
<span class="parent-field">logging.</span><a id="logging-secretOptions" href="#logging-secretOptions" class="field">`secretOptions`</a> <span class="type">Map</span>
231+
Optional. The secrets to pass to the log configuration.
232+
233+
<span class="parent-field">logging.</span><a id="logging-configFilePath" href="#logging-configFilePath" class="field">`configFilePath`</a> <span class="type">Map</span>
234+
Optional. The full config file path in your custom Fluent Bit image.
235+
236+
<div class="separator"></div>
237+
218238
<a id="environments" href="#environments" class="field">`environments`</a> <span class="type">Map</span>
219239
The environment section lets you override any value in your manifest based on the environment you're in. In the example manifest above, we're overriding the count parameter so that we can run 2 copies of our service in our prod environment.

site/content/docs/manifest/scheduled-job.en.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -222,6 +222,28 @@ Optional. Defaults to `true`. Whether or not to use IAM authorization to determi
222222
<span class="parent-field">volume.efs.auth.</span><a id="access_point_id" href="#access-point-id" class="field">`access_point_id`</a> <span class="type">String</span>
223223
Optional. Defaults to `""`. The ID of the EFS access point to connect to. If using an access point, `root_dir` must be either empty or `/` and `auth.iam` must be `true`.
224224

225+
<div class="separator"></div>
226+
227+
<a id="logging" href="#logging" class="field">`logging`</a> <span class="type">Map</span>
228+
The logging section contains log configuration parameters for your container's [FireLens](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) log driver (see examples [here](../developing/sidecars.en.md#sidecar-patterns)).
229+
230+
<span class="parent-field">logging.</span><a id="logging-image" href="#logging-image" class="field">`image`</a> <span class="type">Map</span>
231+
Optional. The Fluent Bit image to use. Defaults to `amazon/aws-for-fluent-bit:latest`.
232+
233+
<span class="parent-field">logging.</span><a id="logging-destination" href="#logging-destination" class="field">`destination`</a> <span class="type">Map</span>
234+
Optional. The configuration options to send to the FireLens log driver.
235+
236+
<span class="parent-field">logging.</span><a id="logging-enableMetadata" href="#logging-enableMetadata" class="field">`enableMetadata`</a> <span class="type">Map</span>
237+
Optional. Whether to include ECS metadata in logs. Defaults to `true`.
238+
239+
<span class="parent-field">logging.</span><a id="logging-secretOptions" href="#logging-secretOptions" class="field">`secretOptions`</a> <span class="type">Map</span>
240+
Optional. The secrets to pass to the log configuration.
241+
242+
<span class="parent-field">logging.</span><a id="logging-configFilePath" href="#logging-configFilePath" class="field">`configFilePath`</a> <span class="type">Map</span>
243+
Optional. The full config file path in your custom Fluent Bit image.
244+
245+
<div class="separator"></div>
246+
225247
<a id="environments" href="#environments" class="field">`environments`</a> <span class="type">Map</span>
226248
The environment section lets you override any value in your manifest based on the environment you're in.
227249
In the example manifest above, we're overriding the CPU parameter so that our production container is more performant.

0 commit comments

Comments
 (0)