StartOTelEnrichment
Enables enrichment and PromQL access for CloudWatch vended metrics for supported AWS resources in the account. Once enabled,
metrics that contain a resource identifier dimension (for example, EC2
CPUUtilization with an InstanceId dimension) are enriched
with resource ARN and resource tag labels and become queryable using PromQL.
Before calling this operation, you must enable resource tags on telemetry for your account. For more information, see Enable resource tags on telemetry.
Optionally, IncludeFilters and ExcludeFilters limit
enrichment to a subset of the account's metrics. These filters are stored only when this
operation starts enrichment. Calling StartOTelEnrichment for an account
where enrichment is already running has no effect and does not modify the filters that
are applied. To change them, use UpdateOTelEnrichment.
Request Parameters
- ExcludeFilters
-
The metric namespaces, and the metric names, to leave unenriched. If this parameter is omitted, nothing is excluded.
Amazon CloudWatch applies
ExcludeFiltersafterIncludeFilters, so a metric that both parameters match is not enriched.A maximum of 100 filters is allowed across
IncludeFiltersandExcludeFilterscombined.Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
- IncludeFilters
-
The metric namespaces, and the metric names, to enrich. If this parameter is omitted, every namespace that Amazon CloudWatch supports for enrichment is in scope.
A maximum of 100 filters is allowed across
IncludeFiltersandExcludeFilterscombined.Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
Required: No
Response Elements
The following elements are returned by the service.
- CreatedAt
-
The date and time that enrichment started for the account.
Type: Timestamp
- ExcludeFilters
-
The exclude filters that are stored for the account.
Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
- IncludeFilters
-
The include filters that are stored for the account.
Type: Array of OTelEnrichmentMetricSelector objects
Array Members: Minimum number of 0 items. Maximum number of 100 items.
- UpdatedAt
-
The date and time that the enrichment configuration for the account was last stored.
Type: Timestamp
Errors
For information about the errors that are common to all actions, see Common Error Types.
- ValidationError
-
The request failed validation. One or more input parameters do not satisfy the constraints that the operation requires.
HTTP Status Code: 400
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following: