Skip to content
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.

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

Adds support for ListMetricAssets endpoint #2404

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-02-28 21:36:53.371453",
"spec_repo_commit": "f478a381"
"regenerated": "2024-02-29 14:49:34.515369",
"spec_repo_commit": "bb5305bc"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-02-28 21:36:53.396731",
"spec_repo_commit": "f478a381"
"regenerated": "2024-02-29 14:49:34.540845",
"spec_repo_commit": "bb5305bc"
}
}
}
301 changes: 288 additions & 13 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11082,6 +11082,136 @@ components:
$ref: '#/components/schemas/MetricAllTags'
readOnly: true
type: object
MetricAssetAttributes:
description: Assets where only included attribute is its title
properties:
title:
description: Title of the asset.
type: string
type: object
MetricAssetDashboardRelationship:
description: An object of type `dashboard` that can be referenced in the `included`
data.
properties:
id:
$ref: '#/components/schemas/MetricDashboardID'
type:
$ref: '#/components/schemas/MetricDashboardType'
type: object
MetricAssetDashboardRelationships:
description: An object containing the list of dashboards that can be referenced
in the `included` data.
properties:
data:
description: A list of dashboards that can be referenced in the `included`
data.
items:
$ref: '#/components/schemas/MetricAssetDashboardRelationship'
type: array
type: object
MetricAssetMonitorRelationship:
description: An object of type `monitor` that can be referenced in the `included`
data.
properties:
id:
$ref: '#/components/schemas/MetricMonitorID'
type:
$ref: '#/components/schemas/MetricMonitorType'
type: object
MetricAssetMonitorRelationships:
description: A object containing the list of monitors that can be referenced
in the `included` data.
properties:
data:
description: A list of monitors that can be referenced in the `included`
data.
items:
$ref: '#/components/schemas/MetricAssetMonitorRelationship'
type: array
type: object
MetricAssetNotebookRelationship:
description: An object of type `notebook` that can be referenced in the `included`
data.
properties:
id:
$ref: '#/components/schemas/MetricNotebookID'
type:
$ref: '#/components/schemas/MetricNotebookType'
type: object
MetricAssetNotebookRelationships:
description: An object containing the list of notebooks that can be referenced
in the `included` data.
properties:
data:
description: A list of notebooks that can be referenced in the `included`
data.
items:
$ref: '#/components/schemas/MetricAssetNotebookRelationship'
type: array
type: object
MetricAssetResponseData:
description: Metric assets response data.
properties:
id:
$ref: '#/components/schemas/MetricName'
relationships:
$ref: '#/components/schemas/MetricAssetResponseRelationships'
type:
$ref: '#/components/schemas/MetricType'
required:
- id
- type
type: object
MetricAssetResponseIncluded:
description: List of included assets with full set of attributes.
oneOf:
- $ref: '#/components/schemas/MetricDashboardAsset'
- $ref: '#/components/schemas/MetricMonitorAsset'
- $ref: '#/components/schemas/MetricNotebookAsset'
- $ref: '#/components/schemas/MetricSLOAsset'
MetricAssetResponseRelationships:
description: Relationships to assets related to the metric.
properties:
dashboards:
$ref: '#/components/schemas/MetricAssetDashboardRelationships'
monitors:
$ref: '#/components/schemas/MetricAssetMonitorRelationships'
notebooks:
$ref: '#/components/schemas/MetricAssetNotebookRelationships'
slos:
$ref: '#/components/schemas/MetricAssetSLORelationships'
type: object
MetricAssetSLORelationship:
description: An object of type `slos` that can be referenced in the `included`
data.
properties:
id:
$ref: '#/components/schemas/MetricSLOID'
type:
$ref: '#/components/schemas/MetricSLOType'
type: object
MetricAssetSLORelationships:
description: An object containing a list of SLOs that can be referenced in the
`included` data.
properties:
data:
description: A list of SLOs that can be referenced in the `included` data.
items:
$ref: '#/components/schemas/MetricAssetSLORelationship'
type: array
type: object
MetricAssetsResponse:
description: Response object that includes related dashboards, monitors, notebooks,
and SLOs.
properties:
data:
$ref: '#/components/schemas/MetricAssetResponseData'
included:
description: Array of objects related to the metric assets.
items:
$ref: '#/components/schemas/MetricAssetResponseIncluded'
type: array
type: object
MetricBulkConfigureTagsType:
default: metric_bulk_configure_tags
description: The metric bulk configure tags resource.
Expand Down Expand Up @@ -11323,6 +11453,44 @@ components:
- MAX
- MIN
- SUM
MetricDashboardAsset:
description: A dashboard object with title and popularity.
properties:
attributes:
$ref: '#/components/schemas/MetricDashboardAttributes'
id:
$ref: '#/components/schemas/MetricDashboardID'
type:
$ref: '#/components/schemas/MetricDashboardType'
required:
- id
- type
type: object
MetricDashboardAttributes:
description: Attributes related to the dashboard, including title and popularity.
properties:
popularity:
description: Value from 0 to 5 that ranks popularity of the dashboard.
format: double
maximum: 5
minimum: 0
type: number
title:
description: Title of the asset.
type: string
type: object
MetricDashboardID:
description: The related dashboard's ID.
example: xxx-yyy-zzz
type: string
MetricDashboardType:
description: Dashboard resource type.
enum:
- dashboards
example: dashboards
type: string
x-enum-varnames:
- DASHBOARDS
MetricDistinctVolume:
description: Object for a single metric's distinct volume.
properties:
Expand Down Expand Up @@ -11463,10 +11631,60 @@ components:
origin:
$ref: '#/components/schemas/MetricOrigin'
type: object
MetricMonitorAsset:
description: A monitor object with title.
properties:
attributes:
$ref: '#/components/schemas/MetricAssetAttributes'
id:
$ref: '#/components/schemas/MetricMonitorID'
type:
$ref: '#/components/schemas/MetricMonitorType'
required:
- id
- type
type: object
MetricMonitorID:
description: The related monitor's ID.
example: '1775073'
type: string
MetricMonitorType:
description: Monitor resource type.
enum:
- monitors
example: monitors
type: string
x-enum-varnames:
- MONITORS
MetricName:
description: The metric name for this resource.
example: test.metric.latency
type: string
MetricNotebookAsset:
description: A notebook object with title.
properties:
attributes:
$ref: '#/components/schemas/MetricAssetAttributes'
id:
$ref: '#/components/schemas/MetricNotebookID'
type:
$ref: '#/components/schemas/MetricNotebookType'
required:
- id
- type
type: object
MetricNotebookID:
description: The related notebook's ID.
example: '12345'
type: string
MetricNotebookType:
description: Notebook resource type.
enum:
- notebooks
example: notebooks
type: string
x-enum-varnames:
- NOTEBOOKS
MetricOrigin:
description: Metric origin information.
properties:
Expand Down Expand Up @@ -11540,6 +11758,31 @@ components:
description: The type of the resource.
type: string
type: object
MetricSLOAsset:
description: A SLO object with title.
properties:
attributes:
$ref: '#/components/schemas/MetricAssetAttributes'
id:
$ref: '#/components/schemas/MetricSLOID'
type:
$ref: '#/components/schemas/MetricSLOType'
required:
- id
- type
type: object
MetricSLOID:
description: The SLO ID.
example: 9ffef113b389520db54391d67d652dfb
type: string
MetricSLOType:
description: SLO resource type.
enum:
- slos
example: slos
type: string
x-enum-varnames:
- SLOS
MetricSeries:
description: 'A metric to submit to Datadog.

Expand Down Expand Up @@ -28087,6 +28330,51 @@ paths:
summary: List tags by metric name
tags:
- Metrics
/api/v2/metrics/{metric_name}/assets:
get:
description: Returns dashboards, monitors, notebooks, and SLOs that a metric
is stored in, if any. Updated every 24 hours.
operationId: ListMetricAssets
parameters:
- $ref: '#/components/parameters/MetricName'
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/MetricAssetsResponse'
description: Success
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response.
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response.
'404':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: API error response.
'429':
content:
application/json:
schema:
$ref: '#/components/schemas/APIErrorResponse'
description: Too Many Requests
security:
- apiKeyAuth: []
appKeyAuth: []
- AuthZ: []
summary: Related Assets to a Metric
tags:
- Metrics
/api/v2/metrics/{metric_name}/estimate:
get:
description: Returns the estimated cardinality for a metric with a given tag,
Expand Down Expand Up @@ -28180,19 +28468,6 @@ paths:
summary: Tag Configuration Cardinality Estimator
tags:
- Metrics
x-dd-ownership:
notification_configuration:
manual_escalation_policy: '[Points Aggregation] Primary'
prod_high_urgency: '@pagerduty-Points-Aggregation @slack-points-aggr-ops'
prod_low_urgency: '@slack-points-aggr-ops'
slack_support_channel: '#points-aggregation'
staging_high_urgency: '@slack-points-aggr-stg-ops'
staging_low_urgency: '@slack-points-aggr-stg-ops'
team: points-aggregation
team_escalation: '[Points Aggregation] Primary'
x-permission:
operator: OPEN
permissions: []
/api/v2/metrics/{metric_name}/tags:
delete:
description: 'Deletes a metric''s tag configuration. Can only be used with application
Expand Down
Loading
Loading