Skip to content

Commit 3d6bef1

Browse files
eschabelleschabell
authored
Update config table for cloudwatch output plugin to match v4.1 release and added add_entity. Fixes #2085. (#2114)
* Removing a readme file this is not standardized in classic-mode directory. Signed-off-by: Eric D. Schabell <[email protected]> * Updated to not use readme file in classic-config directory, but the correct description file. Signed-off-by: Eric D. Schabell <[email protected]> * Updated to better sort some sections and update for missing entries. Fixes #2108. Signed-off-by: Eric D. Schabell <[email protected]> * Updated configuration variables for opentelemetry output plugin, many new ones added. Signed-off-by: Eric D. Schabell <[email protected]> * Updated configuration variables for opentelemetry output plugin, many new ones added. Fixes #2083 Signed-off-by: Eric D. Schabell <[email protected]> * Fixes reqeusted by reviewers for options table for opentelemetry output plugin. Signed-off-by: Eric D. Schabell <[email protected]> * Update config table for cloudwatch output plugin to match v4.1 release and added add_entity. Fixes #2085. Signed-off-by: Eric D. Schabell <[email protected]> * Fixing vale issue. Signed-off-by: Eric D. Schabell <[email protected]> * Fixing vale issue. Signed-off-by: Eric D. Schabell <[email protected]> --------- Signed-off-by: Eric D. Schabell <[email protected]>
1 parent 24aafb1 commit 3d6bef1

File tree

1 file changed

+31
-22
lines changed

1 file changed

+31
-22
lines changed

‎pipeline/outputs/cloudwatch.md‎

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -14,28 +14,37 @@ See [AWS credentials](https://docs.fluentbit.io/manual/administration/aws-creden
1414

1515
## Configuration parameters
1616

17-
| Key | Description |
18-
|----- |------------------ |
19-
| `region` | The AWS region. |
20-
| `log_group_name` | The name of the CloudWatch log group that you want log records sent to. |
21-
| `log_group_template` | Optional. Template for the log group name using Fluent Bit [`record_accessor`](https://docs.fluentbit.io/manual/administration/configuring-fluent-bit/classic-mode/record-accessor) syntax. If configured, this field overrides the `log_group_name`. If the template translation fails, an error is logged and the `log_group_name` is used instead. See the tutorial for an example. |
22-
| `log_stream_name` | The name of the CloudWatch log stream that you want log records sent to. |
23-
| `log_stream_prefix` | Prefix for the log stream name. The tag is appended to the prefix to construct the full log stream name. Not compatible with the `log_stream_name` option. |
24-
| `log_stream_template` | Optional. Template for log stream name using Fluent Bit [`record_accessor`](https://docs.fluentbit.io/manual/administration/configuring-fluent-bit/classic-mode/record-accessor) syntax. If configured, it overrides other log stream options. If the template translation fails, an error is logged and `log_stream_name` or `log_stream_prefix` are used instead (one of those fields must be configured). See the tutorial for an example. |
25-
| `log_key` | By default, the whole log record will be sent to CloudWatch. If you specify a key name with this option, then only the value of that key will be sent to CloudWatch. For example, if you are using the Fluentd Docker log driver, you can specify `log_key log` and only the log message will be sent to CloudWatch. |
26-
| `log_format` | Optional. A parameter that can be used to tell CloudWatch the format of the data. A value of `json/emf` enables CloudWatch to extract custom metrics embedded in a JSON payload. See the [Embedded Metric Format](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/CloudWatch_Embedded_Metric_Format_Specification.html) specification. |
27-
| `role_arn` | ARN of an IAM role to assume for cross account access. |
28-
| `auto_create_group` | Automatically create the log group. Allowed values: `true`, `false` (case insensitive). Defaults to `false`. |
29-
| `log_group_class` | Optional. Specifies the log storage class for new log groups when `auto_create_group` is set to `true`. You can't modify the storage class of existing log groups. Allowed values: `STANDARD`, `INFREQUENT_ACCESS`. Default: `STANDARD`. |
30-
| `log_retention_days` | If set to a number greater than zero, and newly create log group's retention policy is set to this many days. Allowed values: [`1`, `3`, `5`, `7`, `14`, `30`, `60`, `90`, `120`, `150`, `180`, `365`, `400`, `545`, `731`, `1827`, `3653`] |
31-
| `endpoint` | Specify a custom endpoint for the CloudWatch Logs API. |
32-
| `metric_namespace` | An optional string representing the CloudWatch namespace for the metrics. See the [Metrics tutorial](#metrics-tutorial) section for a full configuration. |
33-
| `metric_dimensions` | A list of lists containing the dimension keys that will be applied to all metrics. The values within a dimension set must be members on the root-node. For more information about dimensions, see [Dimension](https://docs.aws.amazon.com/AmazonCloudWatch/latest/APIReference/API_Dimension.html) and [Dimensions](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/cloudwatch_concepts.html#Dimension). In the Fluent Bit configurations, `metric_dimensions` is a comma and semicolon separated string. If you have only one list of dimensions, put the values as a comma separated string. If you want to put list of lists, use the list as semicolon separated strings. For example, if you set the value as `dimension_1,dimension_2;dimension_3`, Fluent Bit converts it as `[[dimension_1, dimension_2],[dimension_3]]`. |
34-
| `sts_endpoint` | Specify a custom STS endpoint for the AWS STS API. |
35-
| `profile` | Option to specify an AWS Profile for credentials. Defaults to `default`. |
36-
| `auto_retry_requests` | Immediately retry failed requests to AWS services once. This option doesn't affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which can help improve throughput when there are transient/random networking issues. Defaults to `true`. |
37-
| `external_id` | Specify an external ID for the STS API, can be used with the `role_arn` parameter if your role requires an external ID. |
38-
| `workers` | The number of [workers](../../administration/multithreading.md#outputs) to perform flush operations for this output. Default: `1`. |
17+
| Key | Description | Default |
18+
|------------------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|------------|
19+
| `add_enity` | Add entity to `PutLogEvent` calls. | `false` |
20+
| `alias` | Sets an alias, useful for multiple instances of the same output plugin. | _none_ |
21+
| `auto_create_group` | Automatically create the log group. Allowed values: `true`, `false` (case insensitive). | `false` |
22+
| `auto_retry_requests` | Immediately retry failed requests to AWS services once. This option doesn't affect the normal Fluent Bit retry mechanism with backoff. Instead, it enables an immediate retry with no delay for networking errors, which can help improve throughput when there are transient/random networking issues. | `true` |
23+
| `endpoint` | Specify a custom endpoint for the CloudWatch Logs API. | _none_ |
24+
| `external_id` | Specify an external ID for the STS API, can be used with the `role_arn` parameter if your role requires an external ID. | _none_ |
25+
| `extra_user_agent` | This option appends a string to the default user agent. AWS asks that you not manually set this field yourself, it is reserved for use in our vended configurations, for example, EKS Container Insights. | _none_ |
26+
| `log_format` | An optional parameter that can be used to tell CloudWatch the format of the data. A value of `json/emf` enables CloudWatch to extract custom metrics embedded in a `JSON` payload. | _none_ |
27+
| `log_group_class` | Specifies the log storage class for new log groups when `auto_create_group` is set to `true`. You can't modify the storage class of existing log groups. Allowed values: `STANDARD`, `INFREQUENT_ACCESS`. | `STANDARD` |
28+
| `log_group_name` | The name of the CloudWatch log group that you want log records sent to. | _none_ |
29+
| `log_group_template` | OTemplate for CW Log Group name using record accessor syntax. Plugin falls back to the log_group_name configured if needed. | _none_ |
30+
| `log_key` | By default, the whole log record will be sent to CloudWatch. If you specify a key name with this option, then only the value of that key will be sent to CloudWatch. For example, if you are using the Fluentd Docker log driver, you can specify `log_key log` and only the log message will be sent to CloudWatch. | _none_ |
31+
| `log_level` | Specifies the log level for output plugin. If not set here, plugin uses global log level in `service` section. | `info` |
32+
| `log_retention_days` | If set to a number greater than zero, and newly create log group's retention policy is set to this many days. Allowed values: [`1`, `3`, `5`, `7`, `14`, `30`, `60`, `90`, `120`, `150`, `180`, `365`, `400`, `545`, `731`, `1827`, `3653`] | `0` |
33+
| `log_stream_name` | The name of the CloudWatch log stream that you want log records sent to. | _none_ |
34+
| `log_stream_prefix` | Prefix for the log stream name. The tag is appended to the prefix to construct the full log stream name. Not compatible with the `log_stream_name` option. | _none_ |
35+
| `log_stream_template` | Template for CloudWatch Log Stream name using record accessor syntax. Plugin falls back to the `log_stream_name` or `log_stream_prefix` configured if needed. | _none_ |
36+
| `log_supress_interval` | Suppresses log messages from output plugin that appear similar within a specified time interval. `0` no suppression. | `0` |
37+
| `match` | Set a tag pattern to match records that output should process. Exact matches or wildcards (for example `*`). | _none_ |
38+
| `match_regex` | Set a regular expression to match tags for output routing. This allows more flexible matching compared to simple wildcards. | _none_ |
39+
| `metric_dimensions` | Metric dimensions is a list of lists. If you have only one list of dimensions, put the values as a comma seperated string. If you want to put list of lists, use the list as semicolon seperated strings. If your value is `d1,d2;d3`, it will consider it as `[[d1, d2],[d3]]`. | _none_ |
40+
| `metric_namespace` | An optional string representing the CloudWatch namespace for the metrics. See the [Metrics tutorial](#metrics-tutorial) section for a full configuration. | _none_ |
41+
| `profile` | Option to specify an AWS Profile for credentials. | _none_ |
42+
| `region` | The AWS region to send logs to. | _none_ |
43+
| `retry_limit` | Set retry limit for output plugin when delivery fails. Integer, `no_limits`, `false`, or `off` to disable, or `no_retries` to disable retries entirely. | `1` |
44+
| `role_arn` | ARN of an IAM role to assume for cross account access. | _none_ |
45+
| `sts_endpoint` | Specify a custom STS endpoint for the AWS STS API. | _none_ |
46+
| `tls.windows.certstore_name` | Sets the certificate store name on an output (Windows). | _none_ |
47+
| `tls.windows.use_enterprise_store` | Sets whether using enterprise certificate store or not on an output (Windows). | _none_ |
3948

4049
## Get started
4150

0 commit comments

Comments
 (0)