alerts

Get misconfigured alerts for a room

Retrieve alerts that are firing too often, stuck in a raised state, silenced for too long, or never dispatched for a given room

post/api/v2/spaces/{spaceID}/rooms/{roomID}/alerts:misconfigured

Request

Path parameters

spaceIDstring uuid required

The unique identifier of the space.

roomIDstring uuid required

The unique identifier of the room.

Request body

categoriesstring[]

Filter results to specific misconfiguration categories; empty means all categories

Example request

{
  "categories": [
    "firing_often",
    "stuck_raised",
    "silenced_long",
    "dispatch_none"
  ],
  "thresholds": {
    "dispatch_none": {
      "count": 10,
      "window_seconds": 2592000
    },
    "firing_often": {
      "transitions": 30,
      "window_seconds": 259200
    },
    "silenced_long": {
      "count": 20,
      "window_seconds": 2592000
    },
    "stuck_raised": {
      "duration_seconds": 1209600
    }
  }
}

Response

The misconfigured alerts results

Example response

{
  "dispatch_none": {
    "items": [
      {
        "alert": {
          "chart": "disk_space._",
          "context": "disk.space",
          "name": "disk_space_usage"
        },
        "count": 42,
        "first": 1710892800000,
        "last": 1711497600000,
        "node": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "ip-172-31-0-1"
        }
      }
    ],
    "totals": {
      "count": 150,
      "items": 3
    }
  },
  "firing_often": {
    "items": [
      {
        "alert": {
          "chart": "system.cpu",
          "context": "system.cpu",
          "name": "10min_cpu_usage"
        },
        "node": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "ip-172-31-0-1"
        },
        "transitions": 100
      }
    ],
    "totals": {
      "items": 5,
      "transitions": 420
    }
  },
  "silenced_long": {
    "items": [
      {
        "alert": {
          "chart": "disk_space._",
          "context": "disk.space",
          "name": "disk_space_usage"
        },
        "count": 72,
        "first_silenced": 1710892800000,
        "last_silenced": 1711497600000,
        "node": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "ip-172-31-0-1"
        }
      }
    ],
    "totals": {
      "count": 150,
      "items": 3
    }
  },
  "stuck_raised": {
    "items": [
      {
        "alert": {
          "chart": "system.cpu",
          "context": "system.cpu",
          "duration_seconds": 86400,
          "name": "10min_cpu_usage",
          "status": "critical",
          "triggered_at": 1710892800000,
          "units": "%",
          "value": 95.5
        },
        "node": {
          "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
          "name": "ip-172-31-0-1"
        }
      }
    ],
    "totals": {
      "critical": {
        "duration_seconds": 172800,
        "items": 2
      },
      "duration_seconds": 259200,
      "items": 3,
      "warning": {
        "duration_seconds": 172800,
        "items": 2
      }
    }
  },
  "thresholds": {
    "dispatch_none": {
      "count": 10,
      "window_seconds": 2592000
    },
    "firing_often": {
      "transitions": 30,
      "window_seconds": 259200
    },
    "silenced_long": {
      "count": 20,
      "window_seconds": 2592000
    },
    "stuck_raised": {
      "duration_seconds": 1209600
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.