Skip to content

Add AWS integration metric name filters and preview endpoints #3749

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
+1,332 −0
Open

Add AWS integration metric name filters and preview endpoints #3749

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
323 changes: 323 additions & 0 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3555,6 +3555,196 @@ components:
type: string
x-enum-varnames:
- LOGS_SERVICES
AWSMetricNameFilterPreviewDDName:
description: A Datadog metric name and whether it is filtered.
properties:
filtered:
description: Whether this Datadog metric name is filtered out.
example: true
type: boolean
name:
description: The Datadog metric name.
example: "aws.ec2.network_in"
type: string
required:
- name
- filtered
type: object
AWSMetricNameFilterPreviewFilterMatch:
description: A metric name filter pattern and how many metrics it matched.
properties:
match_count:
description: The number of Datadog metric names matched by this pattern.
example: 1
format: int64
type: integer
pattern:
description: The metric name filter pattern.
example: "aws.ec2.network_in"
type: string
required:
- pattern
- match_count
type: object
AWSMetricNameFilterPreviewMetric:
description: A CloudWatch metric and the Datadog metric names it produces.
properties:
cw_name:
description: The CloudWatch metric name.
example: "NetworkIn"
type: string
dd_names:
description: The Datadog metric names produced from this CloudWatch metric.
items:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewDDName"
type: array
required:
- cw_name
- dd_names
type: object
AWSMetricNameFilterPreviewNamespace:
description: The metric name filter preview for a single namespace.
properties:
filters:
description: The metric name filter patterns evaluated for this namespace and how many metrics they matched.
items:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewFilterMatch"
type: array
metrics:
description: |-
The CloudWatch metrics collected for this namespace and whether each resulting
Datadog metric is filtered.
items:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewMetric"
type: array
namespace:
description: The AWS CloudWatch namespace.
example: "AWS/EC2"
type: string
required:
- namespace
- filters
- metrics
type: object
AWSMetricNameFilterPreviewRequest:
description: AWS metric name filter preview request body.
properties:
data:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewRequestData"
required:
- data
type: object
AWSMetricNameFilterPreviewRequestAttributes:
description: AWS metric name filter preview request attributes.
properties:
metric_name_filters:
description: The metric name filters to preview.
items:
$ref: "#/components/schemas/AWSMetricNameFilters"
type: array
required:
- metric_name_filters
type: object
AWSMetricNameFilterPreviewRequestData:
description: AWS metric name filter preview request data.
properties:
attributes:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewRequestAttributes"
type:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewType"
required:
- type
- attributes
type: object
AWSMetricNameFilterPreviewResponse:
description: AWS metric name filter preview response body.
properties:
data:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewResponseData"
required:
- data
type: object
AWSMetricNameFilterPreviewResponseAttributes:
description: AWS metric name filter preview response attributes.
properties:
namespaces:
description: The list of namespaces affected by the previewed metric name filters.
items:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewNamespace"
type: array
required:
- namespaces
type: object
AWSMetricNameFilterPreviewResponseData:
description: AWS metric name filter preview response data.
properties:
attributes:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewResponseAttributes"
id:
$ref: "#/components/schemas/AWSAccountConfigID"
type:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewType"
required:
- id
- type
- attributes
type: object
AWSMetricNameFilterPreviewType:
default: "metric_name_filter_preview"
description: The `AWSMetricNameFilterPreviewResponseData` `type`.
enum:
- metric_name_filter_preview
example: "metric_name_filter_preview"
type: string
x-enum-varnames:
- METRIC_NAME_FILTER_PREVIEW
AWSMetricNameFilters:
description: |-
AWS CloudWatch metric name filter for a single namespace.
Exactly one of `include_only` or `exclude_only` must be set.
oneOf:
- $ref: "#/components/schemas/AWSMetricNameFiltersIncludeOnly"
- $ref: "#/components/schemas/AWSMetricNameFiltersExcludeOnly"
AWSMetricNameFiltersExcludeOnly:
description: Exclude metric names matching one of these patterns for a single namespace.
properties:
exclude_only:
description: Exclude metric names matching one of these patterns.
example:
- "aws.ec2.network_in"
items:
description: A metric name pattern to exclude.
example: "aws.ec2.network_in"
type: string
type: array
namespace:
description: The AWS CloudWatch namespace to which this metric name filter applies.
example: "AWS/EC2"
type: string
required:
- namespace
- exclude_only
type: object
AWSMetricNameFiltersIncludeOnly:
description: Include only metric names matching one of these patterns for a single namespace.
properties:
include_only:
description: Include only metric names matching one of these patterns.
example:
- "aws.ec2.network_in"
items:
description: A metric name pattern to include.
example: "aws.ec2.network_in"
type: string
type: array
namespace:
description: The AWS CloudWatch namespace to which this metric name filter applies.
example: "AWS/EC2"
type: string
required:
- namespace
- include_only
type: object
AWSMetricsConfig:
description: AWS Metrics Collection config.
properties:
Expand All @@ -3574,6 +3764,13 @@ components:
description: Enable AWS metrics collection. Defaults to `true`.
example: true
type: boolean
metric_name_filters:
description: |-
AWS CloudWatch metric name filters. Each filter applies to a single namespace.
Exactly one of `include_only` or `exclude_only` must be set on each filter.
items:
$ref: "#/components/schemas/AWSMetricNameFilters"
type: array
namespace_filters:
$ref: "#/components/schemas/AWSNamespaceFilters"
tag_filters:
Expand Down Expand Up @@ -141429,6 +141626,10 @@ paths:
collect_cloudwatch_alarms: false
collect_custom_metrics: false
enabled: true
metric_name_filters:
- include_only:
- aws.ec2.network_in
namespace: AWS/EC2
tag_filters:
- namespace: AWS/EC2
resources_config:
Expand Down Expand Up @@ -141567,6 +141768,10 @@ paths:
collect_cloudwatch_alarms: false
collect_custom_metrics: false
enabled: true
metric_name_filters:
- include_only:
- aws.ec2.network_in
namespace: AWS/EC2
tag_filters:
- namespace: AWS/EC2
resources_config:
Expand Down Expand Up @@ -141811,6 +142016,124 @@ paths:
x-unstable: |-
**Note**: This endpoint is in preview and may be subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/integration/aws/accounts/{aws_account_config_id}/metric_name_filter_preview:
get:
description: |-
Preview which collected CloudWatch metrics would be filtered by the account's saved metric name filters.
operationId: GetAWSMetricNameFilterPreview
parameters:
- $ref: "#/components/parameters/AWSAccountConfigIDPathParameter"
responses:
"200":
content:
application/json:
examples:
default:
value:
data:
attributes:
namespaces:
- filters:
- match_count: 1
pattern: "aws.ec2.network_in"
metrics:
- cw_name: "NetworkIn"
dd_names:
- filtered: true
name: "aws.ec2.network_in"
namespace: "AWS/EC2"
id: "00000000-0000-0000-0000-000000000001"
type: metric_name_filter_preview
schema:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewResponse"
description: AWS metric name filter preview result
"403":
$ref: "#/components/responses/ForbiddenResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
summary: Get AWS metric name filter preview
tags:
- AWS Integration
"x-permission":
operator: OR
permissions:
- aws_configuration_read
x-unstable: |-
**Note**: This endpoint is in preview and is subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
post:
description: |-
Preview which collected CloudWatch metrics would be filtered by the supplied metric name filters.
The filters are not persisted.
operationId: PreviewAWSMetricNameFilter
parameters:
- $ref: "#/components/parameters/AWSAccountConfigIDPathParameter"
requestBody:
content:
application/json:
examples:
default:
value:
data:
attributes:
metric_name_filters:
- exclude_only:
- "aws.ec2.network_in"
namespace: "AWS/EC2"
type: metric_name_filter_preview
schema:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewRequest"
description: The metric name filters to preview.
required: true
responses:
"200":
content:
application/json:
examples:
default:
value:
data:
attributes:
namespaces:
- filters:
- match_count: 1
pattern: "aws.ec2.network_in"
metrics:
- cw_name: "NetworkIn"
dd_names:
- filtered: true
name: "aws.ec2.network_in"
namespace: "AWS/EC2"
id: "00000000-0000-0000-0000-000000000001"
type: metric_name_filter_preview
schema:
$ref: "#/components/schemas/AWSMetricNameFilterPreviewResponse"
description: AWS metric name filter preview result
"400":
content:
application/json:
schema:
$ref: "#/components/schemas/JSONAPIErrorResponse"
description: Bad Request
"403":
$ref: "#/components/responses/ForbiddenResponse"
"404":
$ref: "#/components/responses/NotFoundResponse"
"429":
$ref: "#/components/responses/TooManyRequestsResponse"
summary: Preview AWS metric name filter
tags:
- AWS Integration
x-codegen-request-body-name: body
"x-permission":
operator: OR
permissions:
- aws_configuration_read
x-unstable: |-
**Note**: This endpoint is in preview and is subject to change.
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).
/api/v2/integration/aws/available_namespaces:
get:
description: Get a list of available AWS CloudWatch namespaces that can send metrics to Datadog.
Expand Down
Loading
Loading