Sign in

v1

latestOpenAPI 3.0.12026-07-13149396412.1 KB
DerivedMetric

put/api/v1/config/derived-metrics/{slug}

Path parameters

slugstring required

Request body

create_if_missingboolean

If true, the DerivedMetric will be created if it does not already exist, identified by slug. If false, an error will be returned if the DerivedMetric does not already exist.

dry_runboolean

If true, the DerivedMetric isn't created or updated, and no response DerivedMetric will be returned. The response will return an error if the given DerivedMetric is invalid.

Example request

{
  "derived_metric": {
    "metric_name": "cpu_usage:instance",
    "queries": [
      {
        "query": {
          "prometheus_expr": "cpu_usage{$service, $instance} / sum(cpu_usage{$service})",
          "variables": [
            {
              "name": "service",
              "default_prometheus_selector": "service=~\".*\""
            }
          ]
        }
      }
    ]
  }
}

Response

A successful response containing the updated DerivedMetric.

Example response

{
  "derived_metric": {
    "metric_name": "cpu_usage:instance",
    "queries": [
      {
        "query": {
          "prometheus_expr": "cpu_usage{$service, $instance} / sum(cpu_usage{$service})",
          "variables": [
            {
              "name": "service",
              "default_prometheus_selector": "service=~\".*\""
            }
          ]
        }
      }
    ]
  }
}