Skip to content

Commit de2893b

Browse files
akhil-sumologicakhil-sumologic
committed
Updated doc for AWS tag filters
1 parent ab73109 commit de2893b

File tree

4 files changed

+26
-9
lines changed

4 files changed

+26
-9
lines changed

‎docs/observability/aws/deploy-use-aws-observability/deploy-with-aws-cloudformation/index.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -84,11 +84,12 @@ You should only install the AWS Observability apps and alerts the first time you
8484

8585
The below tables displays the response for each text box in this section.
8686

87-
| Prompt | Guideline |
88-
|:--|:--|
89-
| Select the kind of CloudWatch Metrics Source to create | **Note:** Switching from one type of Metrics Source to another can result in re-computation of your Root Cause Explorer anomaly detection models. This re-computation can take a couple of days to finish and meanwhile you will not get new Events of Interest (EOIs).<ul><li>**CloudWatch Metrics Source** - Creates Sumo Logic AWS CloudWatch Metrics Sources.</li><li>**Kinesis Firehose Metrics Source (Recommended)** - Creates a Sumo Logic AWS Kinesis Firehose for Metrics Source.<br/>**Note:** This new source has cost and performance benefits over the CloudWatch Metrics Source is therefore recommended.</li><li>**None** - Skips the Installation of both the Sumo Logic Sources</li></ul> |
90-
| Sumo Logic AWS Metrics Namespaces | Enter a comma-delimited list of the namespaces which will be used for both AWS CloudWatch Metrics and Inventory Sources.<br/>The default will be AWS/ApplicationELB, AWS/ApiGateway, AWS/DynamoDB, AWS/Lambda, AWS/RDS, AWS/ECS, AWS/ElastiCache, AWS/ELB, AWS/NetworkELB, AWS/SQS, AWS/SNS, and AWS/EC2.<br/> AWS/AutoScaling will be appended to Namespaces for Inventory Sources.<br/>Supported namespaces are based on the type of CloudWatch Metrics Source you have selected above. See the relevant docs for the [Kinesis Firehose Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source.md) and the [CloudWatch Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics.md) for details on which namespaces they support. |
91-
| Existing Sumo Logic Metrics Source API URL | You must supply this URL if you are already collecting CloudWatch Metrics. Provide the existing Sumo Logic Metrics Source API URL. The account field will be added to the Source. For information on how to determine the URL, see [View or Download Source JSON Configuration](/docs/send-data/use-json-configure-sources/local-configuration-file-management/view-download-source-json-configuration.md). |
87+
| Prompt | Guideline |
88+
|:-------------------------------------------------------|:-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
89+
| Select the kind of CloudWatch Metrics Source to create | **Note:** Switching from one type of Metrics Source to another can result in re-computation of your Root Cause Explorer anomaly detection models. This re-computation can take a couple of days to finish and meanwhile you will not get new Events of Interest (EOIs).<ul><li>**CloudWatch Metrics Source** - Creates Sumo Logic AWS CloudWatch Metrics Sources.</li><li>**Kinesis Firehose Metrics Source (Recommended)** - Creates a Sumo Logic AWS Kinesis Firehose for Metrics Source.<br/>**Note:** This new source has cost and performance benefits over the CloudWatch Metrics Source is therefore recommended.</li><li>**None** - Skips the Installation of both the Sumo Logic Sources</li></ul> |
90+
| Sumo Logic AWS Metrics Namespaces | Enter a comma-delimited list of the namespaces which will be used for both AWS CloudWatch Metrics and Inventory Sources.<br/>The default will be AWS/ApplicationELB, AWS/ApiGateway, AWS/DynamoDB, AWS/Lambda, AWS/RDS, AWS/ECS, AWS/ElastiCache, AWS/ELB, AWS/NetworkELB, AWS/SQS, AWS/SNS, and AWS/EC2.<br/> AWS/AutoScaling will be appended to Namespaces for Inventory Sources.<br/>Supported namespaces are based on the type of CloudWatch Metrics Source you have selected above. See the relevant docs for the [Kinesis Firehose Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source.md) and the [CloudWatch Metrics Source](/docs/send-data/hosted-collectors/amazon-aws/amazon-cloudwatch-source-metrics.md) for details on which namespaces they support. |
91+
| Existing Sumo Logic Metrics Source API URL | You must supply this URL if you are already collecting CloudWatch Metrics. Provide the existing Sumo Logic Metrics Source API URL. The account field will be added to the Source. For information on how to determine the URL, see [View or Download Source JSON Configuration](/docs/send-data/use-json-configure-sources/local-configuration-file-management/view-download-source-json-configuration.md). |
92+
| Sumo Logic AWS Metrics Tag Filters | Provide JSON format of the namespaces with it's tags values to add filters to your metrics. Use semicolons to separate multiple values for the same tag key. AWS Tag Filters will be added to the Source, see JSON format example. ```json { "AWS/ELB": { "tags": ["env=prod;dev"] }, "AWS/EC2": { "tags": ["env=dev"] }, "AWS/RDS": { "tags": ["env=dev"] } } ``` |
9293

9394
## Step 6: Sumo Logic AWS ALB Log Source
9495

‎docs/observability/aws/deploy-use-aws-observability/deploy-with-terraform.md‎

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -695,7 +695,8 @@ Supported namespaces are based on the type of CloudWatch Metrics Source you have
695695
"AWS/NetworkELB",
696696
"AWS/SQS",
697697
"AWS/SNS"
698-
],
698+
],
699+
"tag_filters": [],
699700
"source_category": "aws/observability/cloudwatch/metrics",
700701
"source_name": "CloudWatch Metrics (Region)"
701702
}
@@ -705,8 +706,8 @@ Supported namespaces are based on the type of CloudWatch Metrics Source you have
705706
706707
The following override example collects only DynamoDB and Lambda namespaces with source_category set to `"aws/observability/cloudwatch/metrics/us-east-1"`:
707708
708-
```json
709-
Cloudwatch_metrics_source_details = {
709+
```json title="cloudwatch_metrics_source_details"
710+
{
710711
"bucket_details": {
711712
"bucket_name": "",
712713
"create_bucket": true,
@@ -717,12 +718,25 @@ Cloudwatch_metrics_source_details = {
717718
"limit_to_namespaces": [
718719
"AWS/DynamoDB",
719720
"AWS/Lambda"
720-
],
721+
],
722+
"tag_filters": [{
723+
"type":"TagFilters",
724+
"namespace" : "AWS/DynamoDB",
725+
"tags": ["env=prod;dev"]
726+
},{
727+
"type": "TagFilters",
728+
"namespace": "AWS/Lambda",
729+
"tags": ["env=prod"]
730+
}],
721731
"source_category": "aws/observability/cloudwatch/metrics/us-east-1",
722732
"source_name": "CloudWatch Metrics us-east-1"
723733
}
724734
```
725735
736+
:::note
737+
All namespaces specified in `tag_filters` must be included in `limit_to_namespaces`.
738+
:::
739+
726740
#### cloudwatch_metrics_source_url
727741
728742
Use this parameter if you are already collecting CloudWatch Metrics and want to use an existing Sumo Logic Collector Source. You need to provide the URL of the existing Sumo Logic CloudWatch Metrics Source. If the URL is for a AWS CloudWatch Metrics source, the "account" and "accountid" metadata fields will be added to the Source. If the URL is for the Kinesis Firehose for Metrics source, the "account" field will be added to the Source. For information on how to determine the URL, see [View or Download Source JSON Configuration](/docs/send-data/use-json-configure-sources/local-configuration-file-management/view-download-source-json-configuration).

‎docs/send-data/hosted-collectors/amazon-aws/aws-kinesis-firehose-metrics-source.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,8 @@ In this step, you create the AWS Kinesis Firehose for Metrics source.
5353
1. Select **AWS Kinesis Firehose** for Metrics.
5454
1. Enter a **Name** for the source.
5555
1. (Optional) Enter a **Description**.
56+
1. (Optional) Enter a **AWS Tag filters**.
57+
**Example** <br/><img src={useBaseUrl('img/send-data/kinesis-aws-tag-filters.png')} alt="kinesis-aws-source.png" style={{border: '1px solid gray'}} width="500"/>
5658
1. For **Source Category**, enter any string to tag the output collected from this Source. Category metadata is stored in a searchable field called `_sourceCategory`.<br/><img src={useBaseUrl('img/send-data/kinesis-aws-source.png')} alt="kinesis-aws-source.png" style={{border: '1px solid gray'}} width="500"/>
5759
1. For **AWS Access** of a Kinesis Metric source, the role requires `tag:GetResources` permission. The Kinesis Log source does not require permissions.
5860
1. Click **Save**.

‎static/img/send-data/kinesis-aws-tag-filters.png‎

103 KB
Loading

0 commit comments

Comments
 (0)