Skip to content

Commit 4e40a87

Browse files
esmerelgguillotte
andauthored
Apply suggestions from code review
Co-authored-by: Garrett Guillotte <[email protected]> Signed-off-by: Lynette Miles <[email protected]>
1 parent f23a3f0 commit 4e40a87

File tree

1 file changed

+11
-11
lines changed

1 file changed

+11
-11
lines changed

pipeline/filters/aws-metadata.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -8,18 +8,18 @@ The plugin supports the following configuration parameters:
88

99
| Key | Description | Default |
1010
| :--- | :--- | :--- |
11-
| `imds_version` | Specify which version of the instance metadata service to use. Valid values are 'v1' or 'v2'. | v2 |
12-
| `az` | The [availability zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html); for example, `us-east-1a`. | `true` |
11+
| `imds_version` | Specify which version of the instance metadata service to use. Valid values are `v1` and `v2`. | `v2` |
12+
| `az` | The [availability zone](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/using-regions-availability-zones.html), such as `us-east-1a`. | `true` |
1313
| `ec2_instance_id` | The EC2 instance ID. | `true` |
1414
| `ec2_instance_type` | The EC2 instance type. | `false` |
1515
| `private_ip` | The EC2 instance private IP. | `false` |
16-
| `ami_id` | The EC2 instance image id. | `false` |
17-
| `account_id` | The account ID for current EC2 instance. | `false` |
18-
| `hostname` | The hostname for current EC2 instance. | `false` |
19-
| `vpc_id` | The VPC ID for current EC2 instance. | `false` |
20-
| `tags_enabled` | Specifies if should attach EC2 instance tags. EC2 instance must have the [instance-metadata-tags](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-metadata-options.html) option enabled, which is disabled by default. | `false` |
21-
| `tags_include` | Defines list of specific EC2 tag keys to inject into the logs. Tag keys must be comma-separated `,`. Tags which aren't present in this list will be ignored. Example: `Name,tag1,tag2`. | _none_ |
22-
| `tags_exclude` | Defines list of specific EC2 tag keys not to inject into the logs. Tag keys must be comma-separated `,`. Tags which aren't present in this list will be injected into the logs. If both `tags_include` and `tags_exclude` are specified, configuration is invalid and plugin fails. Example: `Name,tag1,tag2` | _none_ |
16+
| `ami_id` | The EC2 instance image ID. | `false` |
17+
| `account_id` | The account ID for the current EC2 instance. | `false` |
18+
| `hostname` | The hostname for the current EC2 instance. | `false` |
19+
| `vpc_id` | The VPC ID for the current EC2 instance. | `false` |
20+
| `tags_enabled` | Specifies whether to attach EC2 instance tags. The EC2 instance must have the [`instance-metadata-tags`](https://awscli.amazonaws.com/v2/documentation/api/latest/reference/ec2/modify-instance-metadata-options.html) option enabled, which is disabled by default. | `false` |
21+
| `tags_include` | Defines a list of specific EC2 tag keys to inject into the logs. Tag keys must be comma-separated (`,`). Tags not included in this list will be ignored. Example: `Name,tag1,tag2`. | _none_ |
22+
| `tags_exclude` | Defines a list of specific EC2 tag keys not to inject into the logs. Tag keys must be comma-separated (`,`). Tags not included in this list will be injected into the logs. If both `tags_include` and `tags_exclude` are specified, the configuration is invalid and the plugin fails. Example: `Name,tag1,tag2` | _none_ |
2323
| `retry_interval_s` |Defines minimum duration between retries for fetching EC2 instance tags. | `300` |
2424

2525
If you run Fluent Bit in a container, you might need to use instance metadata v1. The plugin behaves the same regardless of which version is used.
@@ -70,7 +70,7 @@ The following is an example of a configuration file:
7070

7171
## EC2 tags
7272

73-
EC2 Tags let you to label and organize your EC2 instances by creating custom-defined key-value pairs. These tags are commonly utilized for resource management, cost allocation, and automation. Including them in the Fluent Bit generated logs is almost essential.
73+
EC2 Tags let you label and organize your EC2 instances by creating custom-defined key-value pairs. These tags are commonly used for resource management, cost allocation, and automation. Including them in the Fluent Bit-generated logs is almost essential.
7474

7575
To achieve this, AWS Filter can be configured with `tags_enabled true` to enable the tagging of logs with the relevant EC2 instance tags. This setup ensures that logs are appropriately tagged, making it easier to manage and analyze them based on specific criteria.
7676

@@ -100,7 +100,7 @@ If you run Fluent Bit logs might look like the following:
100100

101101
#### `tags_exclude`
102102

103-
Suppose the EC2 instance has three tags: `Name:fluent-bit-docs-example`, `project:fluentbit`, and `department:it`. In this example, the `department` tag is redundant and will be excluded. All of the projects belong to the `it` department, and you don't want to waste storage space on redundant labels.
103+
Suppose the EC2 instance has three tags: `Name:fluent-bit-docs-example`, `project:fluentbit`, and `department:it`. In this example, the `department` tag is redundant and will be excluded. All of the projects belong to the `it` department, and you don't want to waste storage space on redundant labels.
104104

105105
Here is an example configuration that achieves this:
106106

0 commit comments

Comments
 (0)