- 필수 기능
- 시작하기
- Glossary
- 표준 속성
- Guides
- Agent
- 통합
- 개방형텔레메트리
- 개발자
- Administrator's Guide
- API
- Datadog Mobile App
- CoScreen
- Cloudcraft
- 앱 내
- 서비스 관리
- 인프라스트럭처
- 애플리케이션 성능
- APM
- Continuous Profiler
- 스팬 시각화
- 데이터 스트림 모니터링
- 데이터 작업 모니터링
- 디지털 경험
- 소프트웨어 제공
- 보안
- AI Observability
- 로그 관리
- 관리
Manage configuration of span-based metrics for your organization. See Generate Metrics from Spans for more information.
GET https://api.ap1.datadoghq.com/api/v2/apm/config/metricshttps://api.datadoghq.eu/api/v2/apm/config/metricshttps://api.ddog-gov.com/api/v2/apm/config/metricshttps://api.datadoghq.com/api/v2/apm/config/metricshttps://api.us3.datadoghq.com/api/v2/apm/config/metricshttps://api.us5.datadoghq.com/api/v2/apm/config/metrics
Get the list of configured span-based metrics with their definitions.
This endpoint requires the apm_read
permission.
OK
All the available span-based metric objects.
항목
유형
설명
data
[object]
A list of span-based metric objects.
attributes
object
The object describing a Datadog span-based metric.
compute
object
The compute rule to compute the span-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
filter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
query
string
The search query - following the span search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the span-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
id
string
The name of the span-based metric.
type
enum
The type of resource. The value should always be spans_metrics.
Allowed enum values: spans_metrics
default: spans_metrics
{
"data": [
{
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": false,
"path": "@duration"
},
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"group_by": [
{
"path": "resource_name",
"tag_name": "resource_name"
}
]
},
"id": "my.metric",
"type": "spans_metrics"
}
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
"""
Get all span-based metrics returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.spans_metrics_api import SpansMetricsApi
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SpansMetricsApi(api_client)
response = api_instance.list_spans_metrics()
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
POST https://api.ap1.datadoghq.com/api/v2/apm/config/metricshttps://api.datadoghq.eu/api/v2/apm/config/metricshttps://api.ddog-gov.com/api/v2/apm/config/metricshttps://api.datadoghq.com/api/v2/apm/config/metricshttps://api.us3.datadoghq.com/api/v2/apm/config/metricshttps://api.us5.datadoghq.com/api/v2/apm/config/metrics
Create a metric based on your ingested spans in your organization.
Returns the span-based metric object from the request body when the request is successful.
This endpoint requires the apm_generate_metrics
permission.
The definition of the new span-based metric.
항목
유형
설명
data [required]
object
The new span-based metric properties.
attributes [required]
object
The object describing the Datadog span-based metric to create.
compute [required]
object
The compute rule to compute the span-based metric.
aggregation_type [required]
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
filter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
query
string
The search query - following the span search syntax.
default: *
group_by
[object]
The rules for the group by.
path [required]
string
The path to the value the span-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
id [required]
string
The name of the span-based metric.
type [required]
enum
The type of resource. The value should always be spans_metrics.
Allowed enum values: spans_metrics
default: spans_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": false,
"path": "@duration"
},
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"group_by": [
{
"path": "resource_name",
"tag_name": "resource_name"
}
]
},
"id": "ExampleSpansMetric",
"type": "spans_metrics"
}
}
OK
The span-based metric object.
항목
유형
설명
data
object
The span-based metric properties.
attributes
object
The object describing a Datadog span-based metric.
compute
object
The compute rule to compute the span-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
filter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
query
string
The search query - following the span search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the span-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
id
string
The name of the span-based metric.
type
enum
The type of resource. The value should always be spans_metrics.
Allowed enum values: spans_metrics
default: spans_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": false,
"path": "@duration"
},
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"group_by": [
{
"path": "resource_name",
"tag_name": "resource_name"
}
]
},
"id": "my.metric",
"type": "spans_metrics"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Conflict
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
"""
Create a span-based metric returns "OK" response
"""
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.spans_metrics_api import SpansMetricsApi
from datadog_api_client.v2.model.spans_metric_compute import SpansMetricCompute
from datadog_api_client.v2.model.spans_metric_compute_aggregation_type import SpansMetricComputeAggregationType
from datadog_api_client.v2.model.spans_metric_create_attributes import SpansMetricCreateAttributes
from datadog_api_client.v2.model.spans_metric_create_data import SpansMetricCreateData
from datadog_api_client.v2.model.spans_metric_create_request import SpansMetricCreateRequest
from datadog_api_client.v2.model.spans_metric_filter import SpansMetricFilter
from datadog_api_client.v2.model.spans_metric_group_by import SpansMetricGroupBy
from datadog_api_client.v2.model.spans_metric_type import SpansMetricType
body = SpansMetricCreateRequest(
data=SpansMetricCreateData(
attributes=SpansMetricCreateAttributes(
compute=SpansMetricCompute(
aggregation_type=SpansMetricComputeAggregationType.DISTRIBUTION,
include_percentiles=False,
path="@duration",
),
filter=SpansMetricFilter(
query="@http.status_code:200 service:my-service",
),
group_by=[
SpansMetricGroupBy(
path="resource_name",
tag_name="resource_name",
),
],
),
id="ExampleSpansMetric",
type=SpansMetricType.SPANS_METRICS,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SpansMetricsApi(api_client)
response = api_instance.create_spans_metric(body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
GET https://api.ap1.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.datadoghq.eu/api/v2/apm/config/metrics/{metric_id}https://api.ddog-gov.com/api/v2/apm/config/metrics/{metric_id}https://api.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.us3.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.us5.datadoghq.com/api/v2/apm/config/metrics/{metric_id}
Get a specific span-based metric from your organization.
This endpoint requires the apm_read
permission.
이름
유형
설명
metric_id [required]
string
The name of the span-based metric.
OK
The span-based metric object.
항목
유형
설명
data
object
The span-based metric properties.
attributes
object
The object describing a Datadog span-based metric.
compute
object
The compute rule to compute the span-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
filter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
query
string
The search query - following the span search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the span-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
id
string
The name of the span-based metric.
type
enum
The type of resource. The value should always be spans_metrics.
Allowed enum values: spans_metrics
default: spans_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": false,
"path": "@duration"
},
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"group_by": [
{
"path": "resource_name",
"tag_name": "resource_name"
}
]
},
"id": "my.metric",
"type": "spans_metrics"
}
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
"""
Get a span-based metric returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.spans_metrics_api import SpansMetricsApi
# there is a valid "spans_metric" in the system
SPANS_METRIC_DATA_ID = environ["SPANS_METRIC_DATA_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SpansMetricsApi(api_client)
response = api_instance.get_spans_metric(
metric_id=SPANS_METRIC_DATA_ID,
)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
PATCH https://api.ap1.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.datadoghq.eu/api/v2/apm/config/metrics/{metric_id}https://api.ddog-gov.com/api/v2/apm/config/metrics/{metric_id}https://api.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.us3.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.us5.datadoghq.com/api/v2/apm/config/metrics/{metric_id}
Update a specific span-based metric from your organization.
Returns the span-based metric object from the request body when the request is successful.
This endpoint requires the apm_generate_metrics
permission.
이름
유형
설명
metric_id [required]
string
The name of the span-based metric.
New definition of the span-based metric.
항목
유형
설명
data [required]
object
The new span-based metric properties.
attributes [required]
object
The span-based metric properties that will be updated.
compute
object
The compute rule to compute the span-based metric.
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
filter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
query
string
The search query - following the span search syntax.
default: *
group_by
[object]
The rules for the group by.
path [required]
string
The path to the value the span-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
type [required]
enum
The type of resource. The value should always be spans_metrics.
Allowed enum values: spans_metrics
default: spans_metrics
{
"data": {
"attributes": {
"compute": {
"include_percentiles": false
},
"filter": {
"query": "@http.status_code:200 service:my-service-updated"
},
"group_by": [
{
"path": "resource_name",
"tag_name": "resource_name"
}
]
},
"type": "spans_metrics"
}
}
OK
The span-based metric object.
항목
유형
설명
data
object
The span-based metric properties.
attributes
object
The object describing a Datadog span-based metric.
compute
object
The compute rule to compute the span-based metric.
aggregation_type
enum
The type of aggregation to use.
Allowed enum values: count,distribution
include_percentiles
boolean
Toggle to include or exclude percentile aggregations for distribution metrics.
Only present when the aggregation_type
is distribution
.
path
string
The path to the value the span-based metric will aggregate on (only used if the aggregation type is a "distribution").
filter
object
The span-based metric filter. Spans matching this filter will be aggregated in this metric.
query
string
The search query - following the span search syntax.
group_by
[object]
The rules for the group by.
path
string
The path to the value the span-based metric will be aggregated over.
tag_name
string
Eventual name of the tag that gets created. By default, the path attribute is used as the tag name.
id
string
The name of the span-based metric.
type
enum
The type of resource. The value should always be spans_metrics.
Allowed enum values: spans_metrics
default: spans_metrics
{
"data": {
"attributes": {
"compute": {
"aggregation_type": "distribution",
"include_percentiles": false,
"path": "@duration"
},
"filter": {
"query": "@http.status_code:200 service:my-service"
},
"group_by": [
{
"path": "resource_name",
"tag_name": "resource_name"
}
]
},
"id": "my.metric",
"type": "spans_metrics"
}
}
Bad Request
API error response.
{
"errors": [
"Bad Request"
]
}
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
"""
Update a span-based metric returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.spans_metrics_api import SpansMetricsApi
from datadog_api_client.v2.model.spans_metric_filter import SpansMetricFilter
from datadog_api_client.v2.model.spans_metric_group_by import SpansMetricGroupBy
from datadog_api_client.v2.model.spans_metric_type import SpansMetricType
from datadog_api_client.v2.model.spans_metric_update_attributes import SpansMetricUpdateAttributes
from datadog_api_client.v2.model.spans_metric_update_compute import SpansMetricUpdateCompute
from datadog_api_client.v2.model.spans_metric_update_data import SpansMetricUpdateData
from datadog_api_client.v2.model.spans_metric_update_request import SpansMetricUpdateRequest
# there is a valid "spans_metric" in the system
SPANS_METRIC_DATA_ATTRIBUTES_FILTER_QUERY = environ["SPANS_METRIC_DATA_ATTRIBUTES_FILTER_QUERY"]
SPANS_METRIC_DATA_ID = environ["SPANS_METRIC_DATA_ID"]
body = SpansMetricUpdateRequest(
data=SpansMetricUpdateData(
attributes=SpansMetricUpdateAttributes(
compute=SpansMetricUpdateCompute(
include_percentiles=False,
),
filter=SpansMetricFilter(
query="@http.status_code:200 service:my-service-updated",
),
group_by=[
SpansMetricGroupBy(
path="resource_name",
tag_name="resource_name",
),
],
),
type=SpansMetricType.SPANS_METRICS,
),
)
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SpansMetricsApi(api_client)
response = api_instance.update_spans_metric(metric_id=SPANS_METRIC_DATA_ID, body=body)
print(response)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"
DELETE https://api.ap1.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.datadoghq.eu/api/v2/apm/config/metrics/{metric_id}https://api.ddog-gov.com/api/v2/apm/config/metrics/{metric_id}https://api.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.us3.datadoghq.com/api/v2/apm/config/metrics/{metric_id}https://api.us5.datadoghq.com/api/v2/apm/config/metrics/{metric_id}
Delete a specific span-based metric from your organization.
This endpoint requires the apm_generate_metrics
permission.
이름
유형
설명
metric_id [required]
string
The name of the span-based metric.
OK
Not Authorized
API error response.
{
"errors": [
"Bad Request"
]
}
Not Found
API error response.
{
"errors": [
"Bad Request"
]
}
Too many requests
API error response.
{
"errors": [
"Bad Request"
]
}
"""
Delete a span-based metric returns "OK" response
"""
from os import environ
from datadog_api_client import ApiClient, Configuration
from datadog_api_client.v2.api.spans_metrics_api import SpansMetricsApi
# there is a valid "spans_metric" in the system
SPANS_METRIC_DATA_ID = environ["SPANS_METRIC_DATA_ID"]
configuration = Configuration()
with ApiClient(configuration) as api_client:
api_instance = SpansMetricsApi(api_client)
api_instance.delete_spans_metric(
metric_id=SPANS_METRIC_DATA_ID,
)
First install the library and its dependencies and then save the example to example.py
and run following commands:
DD_SITE="datadoghq.comus3.datadoghq.comus5.datadoghq.comdatadoghq.euap1.datadoghq.comddog-gov.com" DD_API_KEY="<API-KEY>" DD_APP_KEY="<APP-KEY>" python3 "example.py"