A Sumo Logic AWS Metadata Source allows you to collect tags from EC2 instances running on AWS. For information about assigning tags to EC2 instances, see Tagging Your Amazon EC2 Resources in AWS help. When you run a metric query, the tags associated with the queried metric will appear as columns in the Legend section of the metric query tab.
These tags are automatically applied to your metrics ingested from other metrics sources, such as host metrics from installed collectors on your EC2 instances. Note that metrics ingested from an HTTP source are not automatically tagged. For HTTP sources, you must add the tags
Region. You can add them in the header with
X-Sumo-Metadata as well as to the metric itself. For reference see Other Supported HTTP Headers.
Only one AWS Metadata Source is required to collect tags from multiple hosts.
Set up an AWS metadata source
To set up an AWS Metadata Source for metrics:
- Grant permission for Sumo Logic to describe EC2 instances. See Grant Access to an AWS Product for details.
- In Sumo Logic select Manage Data > Collection > Collection.
- Next to a Hosted Collector, click Add Source.
- Select AWS Metadata.
- Configure the following:
- Name. Enter a name to display for the new Source.
- Description. Optional description.
- Regions. Select one or more Amazon regions.
- Tag Filters. Leave this field blank to collect all tags configured for the EC2 instance. To collect a subset of tags, follow the instructions in Define EC2 tag filters.
- AWS Access. Choose between two Access Method options. Select Role-based access or Key access based on the AWS authentication you are providing. Role-based access is preferred, this was completed in step 1, see Grant Sumo Logic access to an AWS Product.
- Click Save.
After creating an AWS Metadata Source, it may take up to 10 minutes for EC2 tags to appear when querying for metrics.
Define EC2 tag filters
Define your filter to match against your tag. For instance, in a key value pair define the filter to match against the key, not the value. If you do not define tag filters, all tags configured for your EC2 instances will be collected.
If you want to collect a subset of tags, you can enter a comma-separated list of one or more of the following types of filters:
- One or more specific tag names, for example, “Cluster, Deployment, Name”
- A wildcard filter, for example, “dev-*”
- An exclusion (blacklist) filter, which begins with an exclamation mark, for example, ”!master-container” or “!prod-*”
For example, assume that the tags configured for your EC2 instances are:
The table below shows the results of several example tag filters
|This tag filter value||Results in collection of these tags|
|Deploy*, !DeployStatus, Cluster||Cluster