{
"trace_metrics_rule": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"group_by": [
{
"key": {
"named_key": "<string>",
"type": "SERVICE"
},
"label": "<string>"
}
],
"histogram_buckets_secs": [
123
],
"metric_labels": {},
"metric_name": "<string>",
"scope_filter": {
"span_scopes": [
{
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
},
"is_root_span": {
"value": true
},
"match_type": "INCLUDE",
"operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"span_count": {
"max": 123,
"min": 123
},
"tags": [
{
"key": "<string>",
"numeric_value": {
"comparison": "EQUAL",
"value": 123
},
"value": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
}
}
]
}
]
},
"slug": "<string>",
"trace_filter": {
"scope_filter": {
"span_scopes": [
{
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
},
"is_root_span": {
"value": true
},
"match_type": "INCLUDE",
"operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"span_count": {
"max": 123,
"min": 123
},
"tags": [
{
"key": "<string>",
"numeric_value": {
"comparison": "EQUAL",
"value": 123
},
"value": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
}
}
]
}
]
},
"span": [
{
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
},
"is_root_span": {
"value": true
},
"match_type": "INCLUDE",
"operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"span_count": {
"max": 123,
"min": 123
},
"tags": [
{
"key": "<string>",
"numeric_value": {
"comparison": "EQUAL",
"value": 123
},
"value": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
}
}
]
}
],
"trace": {
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
}
}
},
"updated_at": "2023-11-07T05:31:56Z"
}
}ReadTraceMetricsRule
{
"trace_metrics_rule": {
"name": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"group_by": [
{
"key": {
"named_key": "<string>",
"type": "SERVICE"
},
"label": "<string>"
}
],
"histogram_buckets_secs": [
123
],
"metric_labels": {},
"metric_name": "<string>",
"scope_filter": {
"span_scopes": [
{
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
},
"is_root_span": {
"value": true
},
"match_type": "INCLUDE",
"operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"span_count": {
"max": 123,
"min": 123
},
"tags": [
{
"key": "<string>",
"numeric_value": {
"comparison": "EQUAL",
"value": 123
},
"value": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
}
}
]
}
]
},
"slug": "<string>",
"trace_filter": {
"scope_filter": {
"span_scopes": [
{
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
},
"is_root_span": {
"value": true
},
"match_type": "INCLUDE",
"operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"span_count": {
"max": 123,
"min": 123
},
"tags": [
{
"key": "<string>",
"numeric_value": {
"comparison": "EQUAL",
"value": 123
},
"value": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
}
}
]
}
]
},
"span": [
{
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
},
"is_root_span": {
"value": true
},
"match_type": "INCLUDE",
"operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_operation": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"parent_service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"service": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
},
"span_count": {
"max": 123,
"min": 123
},
"tags": [
{
"key": "<string>",
"numeric_value": {
"comparison": "EQUAL",
"value": 123
},
"value": {
"in_values": [
"<string>"
],
"match": "EXACT",
"value": "<string>"
}
}
]
}
],
"trace": {
"duration": {
"max_secs": 123,
"min_secs": 123
},
"error": {
"value": true
}
}
},
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Chronosphere API token
Path Parameters
Response
A successful response.
Show child attributes
Show child attributes
The name of the TraceMetricsRule. You can modify this value after the TraceMetricsRule is created.
Timestamp of when the TraceMetricsRule was created. Cannot be set by clients.
Add labels to the resultant metrics based on the specified key:value pairs.
Show child attributes
Show child attributes
The label to use in the resulting metrics.
Histogram bucket values, in seconds, for generated duration metrics.
The name of the generated trace metrics.
Scope filter to determine which spans should be counted for metrics generation. Only spans matching the scope filter will contribute to trace metrics.
Show child attributes
Show child attributes
Specifies the span filters that define which spans contribute to the metrics calculation. Only spans matching these filters will be included in the metrics aggregation.
Show child attributes
Show child attributes
Matches the duration of the candidate span.
Show child attributes
Show child attributes
Matches the root span of a trace. For example, if the parent span has no child spans.
Show child attributes
Show child attributes
The value of the filter compared to the target trace or span field.
If INCLUDE, includes all traces that have at least one (or span_count)
spans matching the query. If EXCLUDE, excludes all traces that have at least
one (or span_count) spans matching the query.
INCLUDE, EXCLUDE Matches the operation of the candidate span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
If not a root span, matches the operation of the candidate span's parent span
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
If not a root span, matches the service of the candidate span's parent span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Matches the service of the candidate span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Defines the number of spans that must match the criteria defined by the span query. Defaults to requiring that at least one span matches the span query.
Matches the tags of the candidate span.
Show child attributes
Show child attributes
The key or name of the span tag that this filter inspects.
If the query matches the tag with the specified key, and the value type is
numeric, specifies the matcher used to evaluate the span tag value.
Show child attributes
Show child attributes
The comparison operation to apply to an input against the given query value.
EQUAL, NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL The filter value used in comparison against match candidates.
If the query matches the tag with the specified key, and the value type is a
string, specifies the matcher used to evaluate the span tag value.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
The unique identifier of the TraceMetricsRule. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the TraceMetricsRule is created.
Filter that defines traces that should yield the defined metrics.
Show child attributes
Show child attributes
Scope filter that defines which spans within matching traces contribute to metrics calculation.
Show child attributes
Show child attributes
Specifies the span filters that define which spans contribute to the metrics calculation. Only spans matching these filters will be included in the metrics aggregation.
Show child attributes
Show child attributes
Matches the duration of the candidate span.
Show child attributes
Show child attributes
Maximum duration, in seconds, required for a span or trace to match.
Minimum duration, in seconds, required for a span or trace to match.
Matches the root span of a trace. For example, if the parent span has no child spans.
Show child attributes
Show child attributes
The value of the filter compared to the target trace or span field.
If INCLUDE, includes all traces that have at least one (or span_count)
spans matching the query. If EXCLUDE, excludes all traces that have at least
one (or span_count) spans matching the query.
INCLUDE, EXCLUDE Matches the operation of the candidate span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
If not a root span, matches the operation of the candidate span's parent span
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
If not a root span, matches the service of the candidate span's parent span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Matches the service of the candidate span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Defines the number of spans that must match the criteria defined by the span query. Defaults to requiring that at least one span matches the span query.
Show child attributes
Show child attributes
Maximum number of spans that must match a span query, inclusive.
Minimum number of spans that must match a span query, inclusive.
Matches the tags of the candidate span.
Show child attributes
Show child attributes
The key or name of the span tag that this filter inspects.
If the query matches the tag with the specified key, and the value type is
numeric, specifies the matcher used to evaluate the span tag value.
Show child attributes
Show child attributes
The comparison operation to apply to an input against the given query value.
EQUAL, NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL The filter value used in comparison against match candidates.
If the query matches the tag with the specified key, and the value type is a
string, specifies the matcher used to evaluate the span tag value.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Specifies the span conditions to match on. All conditions must be true in a
single span for the span to be considered a match. If span_count is specified,
the number of spans within the trace that match span conditions must be within
[min, max]. You can specify multiple span conditions, and each can be
satisfied by any number of spans within the trace.
Show child attributes
Show child attributes
Matches the duration of the candidate span.
If INCLUDE, includes all traces that have at least one (or span_count)
spans matching the query. If EXCLUDE, excludes all traces that have at least
one (or span_count) spans matching the query.
INCLUDE, EXCLUDE Matches the operation of the candidate span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
If not a root span, matches the operation of the candidate span's parent span
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
If not a root span, matches the service of the candidate span's parent span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Matches the service of the candidate span.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Defines the number of spans that must match the criteria defined by the span query. Defaults to requiring that at least one span matches the span query.
Matches the tags of the candidate span.
Show child attributes
Show child attributes
The key or name of the span tag that this filter inspects.
If the query matches the tag with the specified key, and the value type is
numeric, specifies the matcher used to evaluate the span tag value.
Show child attributes
Show child attributes
The comparison operation to apply to an input against the given query value.
EQUAL, NOT_EQUAL, GREATER_THAN, GREATER_THAN_OR_EQUAL, LESS_THAN, LESS_THAN_OR_EQUAL The filter value used in comparison against match candidates.
If the query matches the tag with the specified key, and the value type is a
string, specifies the matcher used to evaluate the span tag value.
Show child attributes
Show child attributes
Values the filter tests against when using IN or NOT_IN match type.
Specifies the comparison operator for the query. If EXACT, compared strings
must have the exact value of the query value.
EXACT, REGEX, EXACT_NEGATION, REGEX_NEGATION, IN, NOT_IN The value of the filter compared to the target trace or span field.
Trace-level filter criteria (effectively matching the root span).
Show child attributes
Show child attributes
Matches traces based on the duration of the entire trace.
Timestamp of when the TraceMetricsRule was last updated. Cannot be set by clients.