CloudWatch / Client / start_otel_enrichment

start_otel_enrichment¶

CloudWatch.Client.start_otel_enrichment(**kwargs)¶

Enables enrichment and PromQL access for CloudWatch vended metrics for supported Amazon Web Services 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 Syntax

response = client.start_otel_enrichment(
    IncludeFilters=[
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ],
    ExcludeFilters=[
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ]
)

Parameters:

IncludeFilters (list) –
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 IncludeFilters and ExcludeFilters combined.
- (dict) –
  
  Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment.
  
  A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.
  - Namespace (string) – [REQUIRED]
    
    The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.
  - MetricNames (list) –
    
    The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.
    
    A maximum of 100 metric names is allowed for each selector.
    - (string) –
ExcludeFilters (list) –
The metric namespaces, and the metric names, to leave unenriched. If this parameter is omitted, nothing is excluded.

Amazon CloudWatch applies ExcludeFilters after IncludeFilters, so a metric that both parameters match is not enriched.

A maximum of 100 filters is allowed across IncludeFilters and ExcludeFilters combined.
- (dict) –
  
  Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment.
  
  A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.
  - Namespace (string) – [REQUIRED]
    
    The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.
  - MetricNames (list) –
    
    The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.
    
    A maximum of 100 metric names is allowed for each selector.
    - (string) –

Return type:

dict

Returns:

Response Syntax

{
    'IncludeFilters': [
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ],
    'ExcludeFilters': [
        {
            'Namespace': 'string',
            'MetricNames': [
                'string',
            ]
        },
    ],
    'CreatedAt': datetime(2015, 1, 1),
    'UpdatedAt': datetime(2015, 1, 1)
}

Response Structure

(dict) –
- IncludeFilters (list) –
  
  The include filters that are stored for the account.
  - (dict) –
    
    Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment.
    
    A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.
    - Namespace (string) –
      
      The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.
    - MetricNames (list) –
      
      The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.
      
      A maximum of 100 metric names is allowed for each selector.
      - (string) –
- ExcludeFilters (list) –
  
  The exclude filters that are stored for the account.
  - (dict) –
    
    Selects the metrics in one namespace, for use in the IncludeFilters or ExcludeFilters parameter of StartOTelEnrichment or UpdateOTelEnrichment.
    
    A maximum of 100 selectors is allowed across IncludeFilters and ExcludeFilters combined.
    - Namespace (string) –
      
      The namespace of the metrics to select. Namespaces are matched exactly and are case-sensitive.
    - MetricNames (list) –
      
      The names of the metrics to select within the namespace. Metric names are matched exactly and are case-sensitive. If this parameter is omitted, every metric in the namespace is selected.
      
      A maximum of 100 metric names is allowed for each selector.
      - (string) –
- CreatedAt (datetime) –
  
  The date and time that enrichment started for the account.
- UpdatedAt (datetime) –
  
  The date and time that the enrichment configuration for the account was last stored.

Exceptions

CloudWatch.Client.exceptions.ValidationException