curl --request POST \
--url https://tenant.name/api/v1/config/rollup-rules \
--header 'API-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"dry_run": true,
"rollup_rule": {
"bucket_slug": "<string>",
"name": "<string>",
"add_metric_type_label": true,
"aggregation": "LAST",
"drop_raw": true,
"expansive_match": true,
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"graphite_label_policy": {
"replace": [
{
"name": "__g1__",
"new_value": "ALL_HOSTS"
}
]
},
"interval": "<string>",
"label_policy": {
"discard": [
"<string>"
],
"keep": [
"<string>"
]
},
"label_replace": {},
"metric_name": "<string>",
"metric_type": "COUNTER",
"mode": "ENABLED",
"skip_on_conflict": true,
"slug": "<string>",
"storage_policy": {
"resolution": "<string>",
"retention": "<string>"
}
}
}
'{
"rollup_rule": {
"bucket_slug": "<string>",
"name": "<string>",
"add_metric_type_label": true,
"aggregation": "LAST",
"created_at": "2023-11-07T05:31:56Z",
"drop_raw": true,
"expansive_match": true,
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"graphite_label_policy": {
"replace": [
{
"name": "__g1__",
"new_value": "ALL_HOSTS"
}
]
},
"interval": "<string>",
"label_policy": {
"discard": [
"<string>"
],
"keep": [
"<string>"
]
},
"label_replace": {},
"metric_name": "<string>",
"metric_type": "COUNTER",
"mode": "ENABLED",
"skip_on_conflict": true,
"slug": "<string>",
"storage_policy": {
"resolution": "<string>",
"retention": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}
}CreateRollupRule
curl --request POST \
--url https://tenant.name/api/v1/config/rollup-rules \
--header 'API-Token: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"dry_run": true,
"rollup_rule": {
"bucket_slug": "<string>",
"name": "<string>",
"add_metric_type_label": true,
"aggregation": "LAST",
"drop_raw": true,
"expansive_match": true,
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"graphite_label_policy": {
"replace": [
{
"name": "__g1__",
"new_value": "ALL_HOSTS"
}
]
},
"interval": "<string>",
"label_policy": {
"discard": [
"<string>"
],
"keep": [
"<string>"
]
},
"label_replace": {},
"metric_name": "<string>",
"metric_type": "COUNTER",
"mode": "ENABLED",
"skip_on_conflict": true,
"slug": "<string>",
"storage_policy": {
"resolution": "<string>",
"retention": "<string>"
}
}
}
'{
"rollup_rule": {
"bucket_slug": "<string>",
"name": "<string>",
"add_metric_type_label": true,
"aggregation": "LAST",
"created_at": "2023-11-07T05:31:56Z",
"drop_raw": true,
"expansive_match": true,
"filters": [
{
"name": "job",
"value_glob": "myservice*"
}
],
"graphite_label_policy": {
"replace": [
{
"name": "__g1__",
"new_value": "ALL_HOSTS"
}
]
},
"interval": "<string>",
"label_policy": {
"discard": [
"<string>"
],
"keep": [
"<string>"
]
},
"label_replace": {},
"metric_name": "<string>",
"metric_type": "COUNTER",
"mode": "ENABLED",
"skip_on_conflict": true,
"slug": "<string>",
"storage_policy": {
"resolution": "<string>",
"retention": "<string>"
},
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Chronosphere API token
Body
If true, validates the specified configuration without creating the RollupRule. If the specified configuration is valid, the endpoint returns a partial response without the RollupRule. If the specified configuration is invalid, the endpoint returns an error.
The RollupRule to create.
Show child attributes
Show child attributes
The slug of the bucket the RollupRule belongs to.
The name of the RollupRule. You can modify this value after the RollupRule is created.
Defines whether to add a __rollup_type__ label in the new metric.
Defines the method by which metrics are aggregated.
LAST, MIN, MAX, MEAN, MEDIAN, COUNT, SUM, SUMSQ, STDEV, P10, P20, P30, P40, P50, P60, P70, P80, P90, P95, P99, P999, P9999, P25, P75, COUNT_SAMPLES, HISTOGRAM Defines whether to automatically generate drop rules for this rollup rule. Set
to true to remove raw metrics that match this rollup rule. Default: false.
DEPRECATED.
A series matches and aggregates only if each label defined by filters and
label_policy.keep or graphite_label_policy.replace (respectively) exist in
the series. Setting expansive_match=true removes this restriction. Default:
expansive_match=false.
If false, a series matches and aggregates only if each label defined by the
provided filters and the label_policy.keep or
graphite_label_policy.replace settings exist in the series.
Filters incoming metrics by label. If multiple label filters are specified, an
incoming metric must match every label filter to match the rule. Label values
support glob patterns, including matching multiple patterns with an OR, such
as service:{svc1,svc2}. These special filters are available for matching
metrics by non-label request metadata:
__metric_type__: Matches the incoming metric's Observability Platform metric type. This is the recommended method for filtering on metric type. Valid values:cumulative_counter,cumulative_exponential_histogram,delta_counter,delta_exponential_histogram,gauge,measurement.__metric_source__: Matches the incoming metric's source format. Valid values:carbon,chrono_gcp,dogstatsd,open_metrics,open_telemetry,prometheus,signalfx,statsd,wavefront.__m3_prom_type__: When ingesting metric data with Prometheus, matches the incoming metric's Prometheus metric type. Valid values:counter,gauge,histogram,gauge_histogram,summary,info,state_set,quantile.__otel_type__: When ingesting with OpenTelemetry, matches on the incoming metric's OpenTelemetry metric type. Valid values:sum,monotonic_sum,gauge,histogram,exp_histogram,summary. For example, the following filter matches any cumulative counter metric with aservice=gatewaylabel whose metric name starts withhttp_requests_:
__metric_type__:cumulative_counter service:gateway __name__:http_requests_*Optional. Label aggregation policy for Graphite metrics. If set, new restrictions will apply to the rule:
label_policycannot be set.metric_namecannot be set.filterscan reference only positional Graphite labels, such as__gX__, and synthetic labels, such as__metric_type__.
Show child attributes
Show child attributes
List of labels to replace. Use to discard high-cardinality values while still preserving the original positions of the Graphite metric.
Show child attributes
Show child attributes
Optional. Sets a custom interval that defines the amount of
time between aggregated data points. Intervals are based on your
retention policy.
This field was known as storage_policies in version
0.286.0-2023-01-06-release.1
and earlier.
Label aggregation policy, which acts as a filter, defining which labels to
preserve in the resulting metric. Use keep to keep one or more labels, or
discard to ignore one or more labels. Required for non-Graphite rules.
DEPRECATED.
The name of the new metric to create and persist to the database. You can use
the template string {{.MetricName }} to create a new metric name that
references the original metric name. For example, new_metric: '{{ .MetricName }}:by_instance' outputs a metric with the name my_metric:by_instance if the
matched metric is my_metric.
This field is optional for Graphite rollup rules.
Declares the metric type of the input metrics. Each rollup rule must declare the
type of metric it aggregates by setting the metric_type field, because each
metric type aggregates differently. Choosing the wrong metric_type for your
rule can produce unexpected results.
COUNTER is deprecated; use CUMULATIVE_COUNTER instead.
DELTA is deprecated; use DELTA_COUNTER instead.
COUNTER, GAUGE, DELTA, DISTRIBUTION, CUMULATIVE_EXPONENTIAL_HISTOGRAM, MEASUREMENT, CUMULATIVE_COUNTER, DELTA_COUNTER, DELTA_EXPONENTIAL_HISTOGRAM The operational mode for this rollup rule. If mode=ENABLED, the rule is
applied. If mode=PREVIEW, the rule is not applied, but shaping impact stats
for the rule are recorded. If empty, defaults to mode=ENABLED.
ENABLED, PREVIEW If true, this rollup rule is skipped if another rollup rule produces a metric with the same output name. Use this flag to write rollup rules that produce metrics only if no other rollup rule produces a series with the same name.
The unique identifier of the RollupRule. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the RollupRule is created.
DEPRECATED.
Use interval instead. Storage policy applied to the resulting
rollup rule, which must match a known storage policy. If empty, the default
storage policy is used. If set, interval can't be set.
Response
A successful response containing the created RollupRule.
Show child attributes
Show child attributes
The slug of the bucket the RollupRule belongs to.
The name of the RollupRule. You can modify this value after the RollupRule is created.
Defines whether to add a __rollup_type__ label in the new metric.
Defines the method by which metrics are aggregated.
LAST, MIN, MAX, MEAN, MEDIAN, COUNT, SUM, SUMSQ, STDEV, P10, P20, P30, P40, P50, P60, P70, P80, P90, P95, P99, P999, P9999, P25, P75, COUNT_SAMPLES, HISTOGRAM Timestamp of when the RollupRule was created. Cannot be set by clients.
Defines whether to automatically generate drop rules for this rollup rule. Set
to true to remove raw metrics that match this rollup rule. Default: false.
DEPRECATED.
A series matches and aggregates only if each label defined by filters and
label_policy.keep or graphite_label_policy.replace (respectively) exist in
the series. Setting expansive_match=true removes this restriction. Default:
expansive_match=false.
If false, a series matches and aggregates only if each label defined by the
provided filters and the label_policy.keep or
graphite_label_policy.replace settings exist in the series.
Filters incoming metrics by label. If multiple label filters are specified, an
incoming metric must match every label filter to match the rule. Label values
support glob patterns, including matching multiple patterns with an OR, such
as service:{svc1,svc2}. These special filters are available for matching
metrics by non-label request metadata:
__metric_type__: Matches the incoming metric's Observability Platform metric type. This is the recommended method for filtering on metric type. Valid values:cumulative_counter,cumulative_exponential_histogram,delta_counter,delta_exponential_histogram,gauge,measurement.__metric_source__: Matches the incoming metric's source format. Valid values:carbon,chrono_gcp,dogstatsd,open_metrics,open_telemetry,prometheus,signalfx,statsd,wavefront.__m3_prom_type__: When ingesting metric data with Prometheus, matches the incoming metric's Prometheus metric type. Valid values:counter,gauge,histogram,gauge_histogram,summary,info,state_set,quantile.__otel_type__: When ingesting with OpenTelemetry, matches on the incoming metric's OpenTelemetry metric type. Valid values:sum,monotonic_sum,gauge,histogram,exp_histogram,summary. For example, the following filter matches any cumulative counter metric with aservice=gatewaylabel whose metric name starts withhttp_requests_:
__metric_type__:cumulative_counter service:gateway __name__:http_requests_*Optional. Label aggregation policy for Graphite metrics. If set, new restrictions will apply to the rule:
label_policycannot be set.metric_namecannot be set.filterscan reference only positional Graphite labels, such as__gX__, and synthetic labels, such as__metric_type__.
Show child attributes
Show child attributes
List of labels to replace. Use to discard high-cardinality values while still preserving the original positions of the Graphite metric.
Show child attributes
Show child attributes
Optional. Sets a custom interval that defines the amount of
time between aggregated data points. Intervals are based on your
retention policy.
This field was known as storage_policies in version
0.286.0-2023-01-06-release.1
and earlier.
Label aggregation policy, which acts as a filter, defining which labels to
preserve in the resulting metric. Use keep to keep one or more labels, or
discard to ignore one or more labels. Required for non-Graphite rules.
DEPRECATED.
The name of the new metric to create and persist to the database. You can use
the template string {{.MetricName }} to create a new metric name that
references the original metric name. For example, new_metric: '{{ .MetricName }}:by_instance' outputs a metric with the name my_metric:by_instance if the
matched metric is my_metric.
This field is optional for Graphite rollup rules.
Declares the metric type of the input metrics. Each rollup rule must declare the
type of metric it aggregates by setting the metric_type field, because each
metric type aggregates differently. Choosing the wrong metric_type for your
rule can produce unexpected results.
COUNTER is deprecated; use CUMULATIVE_COUNTER instead.
DELTA is deprecated; use DELTA_COUNTER instead.
COUNTER, GAUGE, DELTA, DISTRIBUTION, CUMULATIVE_EXPONENTIAL_HISTOGRAM, MEASUREMENT, CUMULATIVE_COUNTER, DELTA_COUNTER, DELTA_EXPONENTIAL_HISTOGRAM The operational mode for this rollup rule. If mode=ENABLED, the rule is
applied. If mode=PREVIEW, the rule is not applied, but shaping impact stats
for the rule are recorded. If empty, defaults to mode=ENABLED.
ENABLED, PREVIEW If true, this rollup rule is skipped if another rollup rule produces a metric with the same output name. Use this flag to write rollup rules that produce metrics only if no other rollup rule produces a series with the same name.
The unique identifier of the RollupRule. If a slug isn't provided, one is generated based on the name field. You can't modify this field after the RollupRule is created.
DEPRECATED.
Use interval instead. Storage policy applied to the resulting
rollup rule, which must match a known storage policy. If empty, the default
storage policy is used. If set, interval can't be set.
Timestamp of when the RollupRule was last updated. Cannot be set by clients.