Pipeline: filters: ecs-metadata: update for style

Signed-off-by: Lynette Miles <[email protected]>

Author: esmerel

pipeline/filters/ecs-metadata.md

@@ -1,42 +1,43 @@
-# ECS Metadata
+# ECS metadata
 
-The _ECS Filter_ Enriches logs with AWS Elastic Container Service Metadata. The plugin can enrich logs with task, cluster and container metadata. The plugin uses the [ECS Agent introspection API](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-introspection.html) to obtain metadata. This filter only works with the ECS EC2 launch type. The filter only works when Fluent Bit is running on an ECS EC2 Container Instance and has access to the ECS Agent introspection API. The filter is not supported on ECS Fargate. To obtain metadata on ECS Fargate, use the [built-in FireLens metadata](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) or the [AWS for Fluent Bit init](https://github.com/aws/aws-for-fluent-bit/blob/mainline/use_cases/init-process-for-fluent-bit/README.md) project.
+The _ECS Filter_ enriches logs with AWS Elastic Container Service metadata. The plugin can enrich logs with task, cluster, and container metadata. The plugin uses the [ECS Agent introspection API](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-agent-introspection.html) to obtain metadata. This filter only works with the ECS EC2 launch type. The filter only works when Fluent Bit is running on an ECS EC2 Container Instance and has access to the ECS Agent introspection API.
 
-## Configuration Parameters
+The filter isn't supported on ECS Fargate. To obtain metadata on ECS Fargate, use the [built-in FireLens metadata](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/using_firelens.html) or the [AWS for Fluent Bit init](https://github.com/aws/aws-for-fluent-bit/blob/mainline/use_cases/init-process-for-fluent-bit/README.md) project.
+
+## Configuration parameters
 
 The plugin supports the following configuration parameters:
 
 | Key | Description | Default |
 | :--- | :--- | :--- |
-| Add | This parameter is similar to the ADD option in the [modify filter](https://docs.fluentbit.io/manual/pipeline/filters/modify).  You can specify it any number of times and it takes two arguments, a KEY name and VALUE. The value uses Fluent Bit [record_accessor](https://docs.fluentbit.io/manual/v/1.5/administration/configuring-fluent-bit/record-accessor) syntax to create a template that uses ECS Metadata values. See the list below for supported metadata templating keys. This option is designed to give you full power to control both the key names for metadata as well as the format for metadata values. See the examples below for more.  | No default |
-| ECS\_Tag\_Prefix | This parameter is similar to the Kube_Tag_Prefix option in the [Kubernetes filter](https://docs.fluentbit.io/manual/pipeline/filters/kubernetes) and performs the same function. The full log tag should be prefixed with this string and after the prefix the filter must find the next characters in the tag to be the Docker Container Short ID (the first 12 characters of the full container ID). The filter uses this to identify which container the log came from so it can find which task it is a part of. See the design section below for more information. If not specified, it defaults to empty string, meaning that the tag must be prefixed with the 12 character container short ID. If you just want to attach cluster metadata to system/OS logs from processes that do not run as part of containers or ECS Tasks, then do not set this parameter and enable the Cluster\_Metadata\_Only option | emptry string |
-| Cluster\_Metadata\_Only | When enabled, the plugin will only attempt to attach cluster metadata values. This is useful if you want to attach cluster metadata to system/OS logs from processes that do not run as part of containers or ECS Tasks. | Off |
-| ECS\_Meta\_Cache\_TTL | The filter builds a hash table in memory mapping each unique container short ID to its metadata. This option sets a max TTL for objects in the hash table. You should set this if you have frequent container/task restarts. For example, your cluster runs short running batch jobs that complete in less than 10 minutes, there is no reason to keep any stored metadata longer than 10 minutes. So you would set this parameter to "10m". | 1h (1 hour) |
+| `Add` | Similar to the `ADD` option in the [modify filter](https://docs.fluentbit.io/manual/pipeline/filters/modify). You can specify it multiple times. It takes two arguments: a `KEY` name and `VALUE`. The value uses Fluent Bit [`record_accessor`](https://docs.fluentbit.io/manual/v/1.5/administration/configuring-fluent-bit/record-accessor) syntax to create a template that uses ECS Metadata values. See the list of supported metadata templating keys. This option is designed to give you full power to control both the key names for metadata and the format for metadata values. | _none_ |
+| `ECS_Tag_Prefix` | Similar to the `Kube_Tag_Prefix` option in the [Kubernetes filter](https://docs.fluentbit.io/manual/pipeline/filters/kubernetes) and performs the same function. The full log tag should be prefixed with this string and after the prefix the filter must find the next characters in the tag to be the Docker Container Short ID (the first 12 characters of the full container ID). The filter uses this to identify which container the log came from so it can find which task it's a part of. See the design section for more information. If not specified, it defaults to empty string, meaning that the tag must be prefixed with the 12 character container short ID. If you want to attach cluster metadata to system or OS logs from processes that don't run as part of containers or ECS Tasks, don't set this parameter and enable the `Cluster_Metadata_Only` option | empty string |
+| `Cluster_Metadata_Only` | When enabled, the plugin will only attempt to attach cluster metadata values. Use to attach cluster metadata to system or OS logs from processes that don't run as part of containers or ECS Tasks. | `Off` |
+| `ECS_Meta_Cache_TTL` | The filter builds a hash table in memory mapping each unique container short ID to its metadata. This option sets a max `TTL` for objects in the hash table. You should set this if you have frequent container or task restarts. For example, your cluster runs short running batch jobs that complete in less than 10 minutes, there is no reason to keep any stored metadata longer than 10 minutes. So you would set this parameter to `10m`. | `1h` |
 
-### Supported Templating Variables for the ADD option
+### Supported templating variables for the `ADD` option
 
-The following template variables can be used for values with the `Add` option. See the tutorial below for examples.
+The following template variables can be used for values with the `Add` option. See the tutorial in the sections following for examples.
 
-| Variable | Description | Supported with Cluster\_Metadata\_Only On |
+| Variable | Description | Supported with `Cluster_Metadata_Only` on |
 | :--- | :--- | :--- |
-| `$ClusterName` | The ECS cluster name. Fluent Bit is running on EC2 instance(s) that are part of this cluster. | Yes |
-| `$ContainerInstanceArn` | The full ARN of the ECS EC2 Container Instance. This is the instance that Fluent Bit is running on. | Yes |
-| `$ContainerInstanceID` | The ID of the ECS EC2 Container Instance. | Yes |
-| `$ECSAgentVersion` | The Version string of the ECS Agent that is running on the container instance. | Yes |
-| `$ECSContainerName` | The name of the container from which the log originated. This is the name in your ECS Task Definition. | No |
-| `$DockerContainerName` | The name of the container from which the log originated. This is the name obtained from Docker and is the name shown if you run `docker ps` on the instance.  | No |
-| `$ContainerID` | The ID of the container from which the log originated. This is the full 64 character long container ID. | No |
-| `$TaskDefinitionFamily` | The family name of the task definition for the task from which the log originated. | No |
-| `$TaskDefinitionVersion` | The version/revision of the task definition for the task from which the log originated. | No |
-| `$TaskID` | The ID of the ECS Task from which the log originated. | No |
-| `$TaskARN` | The full ARN of the ECS Task from which the log originated. | No |
-
-
-### Configuration File
+| `$ClusterName` | The ECS cluster name. Fluent Bit is running on EC2 instances that are part of this cluster. | `Yes` |
+| `$ContainerInstanceArn` | The full ARN of the ECS EC2 Container Instance. This is the instance that Fluent Bit is running on. | `Yes` |
+| `$ContainerInstanceID` | The ID of the ECS EC2 Container Instance. | `Yes` |
+| `$ECSAgentVersion` | The Version string of the ECS Agent running on the container instance. | `Yes` |
+| `$ECSContainerName` | The name of the container from which the log originated. This is the name in your ECS Task Definition. | `No` |
+| `$DockerContainerName` | The name of the container from which the log originated. This is the name obtained from Docker and is the name shown if you run `docker ps` on the instance.  | `No` |
+| `$ContainerID` | The ID of the container from which the log originated. This is the full 64 character long container ID. | `No` |
+| `$TaskDefinitionFamily` | The family name of the task definition for the task from which the log originated. | `No` |
+| `$TaskDefinitionVersion` | The version or revision of the task definition for the task from which the log originated. | `No` |
+| `$TaskID` | The ID of the ECS Task from which the log originated. | `No` |
+| `$TaskARN` | The full ARN of the ECS Task from which the log originated. | `No` |
+
+### Configuration file
 
 #### Example 1: Attach Task ID and cluster name to container logs
 
-```text
+```python
 [INPUT]
     Name                tail
     Tag                 ecs.*
@@ -67,6 +68,7 @@ The following template variables can be used for values with the `Add` option. S
 ```
 
 The output log should be similar to:
+
 ```text
 {
     "date":1665003546.0,
@@ -108,6 +110,7 @@ The output log should be similar to:
 ```
 
 The output log would be similar to:
+
 ```text
 {
     "date":1665003546.0,
@@ -116,14 +119,14 @@ The output log would be similar to:
 }
 ```
 
-Notice that the template variables in the value for the `resource` key are separated by dot characters, only dots and commas
- (`.` and `,`) can come after a template variable. For more information, please check the [Record accessor limitation's section](../../administration/configuring-fluent-bit/classic-mode/record-accessor.md#limitations-of-record_accessor-templating).
+The template variables in the value for the `resource` key are separated by dot characters. Only dots and commas
+ (`.` and `,`) can come after a template variable. For more information, see the [Record accessor limitation's section](../../administration/configuring-fluent-bit/classic-mode/record-accessor.md#limitations-of-record_accessor-templating).
 
 #### Example 3: Attach cluster metadata to non-container logs
 
-This examples shows a use case for the `Cluster_Metadata_Only` option- attaching cluster metadata to ECS Agent logs. 
+This examples shows a use case for the `Cluster_Metadata_Only` option- attaching cluster metadata to ECS Agent logs.
 
-```text
+```python
 [INPUT]
     Name                tail
     Tag                 ecsagent.*
@@ -148,4 +151,3 @@ This examples shows a use case for the `Cluster_Metadata_Only` option- attaching
     Match *
     Format json_lines
 ```
-

vale-styles/FluentBit/Acronyms.yml

@@ -26,6 +26,7 @@ exceptions:
   - DNS
   - DPI
   - DPPS
+  - ECS
   - FAQ
   - FIPS
   - GCC