Skip to main content

irm

Typed specification

Generated by the pinned ess generate --kind docs from adapters/grafana/spec/ess. Structural validation establishes consistency; behaviour, storage and cross-record predicates remain implementation obligations.

Grafana Cloud IRM alert groups, incidents and the alert groups an incident references, read over a since window the caller advances; read only.

connectors_grafana.irm is one of connectors_grafana's bounded contexts. Back to the index.

Types​

AlertGroupCursor​

connectors_grafana.irm.AlertGroupCursor wraps String and is not interchangeable with one: the whole value of naming it separately is the crossings the model then refuses. Its characters are drawn from 0123456789. Every value satisfies (value.count >= 1 and value.count <= 6).

AlertGroupPage​

connectors_grafana.irm.AlertGroupPage is a record of four fields:

  • items — List<connectors_grafana.irm.AlertGroupRecord>
  • complete — Boolean
  • next_cursor — Optional<connectors_grafana.irm.AlertGroupCursor>, which may be absent
  • window — connectors_grafana.irm.Window

Every value satisfies items.count <= 100.

AlertGroupRecord​

connectors_grafana.irm.AlertGroupRecord is a record of 12 fields:

  • id — connectors_grafana.irm.IrmId
  • integration_id — connectors_grafana.irm.IrmId
  • route_id — Optional<connectors_grafana.irm.IrmId>, which may be absent
  • alert_group_number — Optional<Integer>, which may be absent
  • alerts_count — Integer
  • state — connectors_grafana.irm.AlertGroupState
  • title — Optional<String>, which may be absent
  • created_at — Timestamp
  • acknowledged_at — Optional<Timestamp>, which may be absent
  • resolved_at — Optional<Timestamp>, which may be absent
  • silenced_at — Optional<Timestamp>, which may be absent
  • root_alert_group_id — Optional<connectors_grafana.irm.IrmId>, which may be absent

Every value satisfies alerts_count >= 0, alert_group_number >= 0 and (title.count >= 1 and title.count <= 4096).

AlertGroupState​

connectors_grafana.irm.AlertGroupState is one of new, acknowledged, resolved and silenced.

connectors_grafana.irm.IncidentAlertGroupLink is a record of two fields:

  • incident_id — connectors_grafana.irm.IncidentId
  • alert_group_id — connectors_grafana.irm.IrmId

IncidentCursor​

connectors_grafana.irm.IncidentCursor wraps String and is not interchangeable with one: the whole value of naming it separately is the crossings the model then refuses. Its characters are drawn from !"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_abcdefghijklmnopqrstuvwxyz{|}~. Every value satisfies (value.count >= 1 and value.count <= 1024)`.

IncidentId​

connectors_grafana.irm.IncidentId wraps String and is not interchangeable with one: the whole value of naming it separately is the crossings the model then refuses. Its characters are drawn from ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789_-. Every value satisfies (value.count >= 1 and value.count <= 64).

IncidentPage​

connectors_grafana.irm.IncidentPage is a record of five fields:

  • items — List<connectors_grafana.irm.IncidentRecord>
  • links — List<connectors_grafana.irm.IncidentAlertGroupLink>
  • complete — Boolean
  • next_cursor — Optional<connectors_grafana.irm.IncidentCursor>, which may be absent
  • window — connectors_grafana.irm.Window

Every value satisfies items.count <= 50 and links.count <= 3200.

IncidentRecord​

connectors_grafana.irm.IncidentRecord is a record of eight fields:

  • incident_id — connectors_grafana.irm.IncidentId
  • title — String
  • status — connectors_grafana.irm.IncidentStatus
  • severity — Optional<String>, which may be absent
  • is_drill — Boolean
  • created_time — Timestamp
  • modified_time — Timestamp
  • closed_time — Optional<Timestamp>, which may be absent

Every value satisfies (title.count >= 1 and title.count <= 4096) and (severity.count >= 1 and severity.count <= 64).

IncidentStatus​

connectors_grafana.irm.IncidentStatus is one of active and resolved.

IrmId​

connectors_grafana.irm.IrmId wraps String and is not interchangeable with one: the whole value of naming it separately is the crossings the model then refuses. Its characters are drawn from ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789. Every value satisfies (value.count >= 1 and value.count <= 64).

Window​

connectors_grafana.irm.Window is a record of two fields:

  • since — Timestamp
  • until — Timestamp

Every value satisfies until > since.

Two of the types above are reached by nothing else in this system: connectors_grafana.irm.AlertGroupPage and connectors_grafana.irm.IncidentPage. No entity, view, command, event, error or crossing names them, so it is either vocabulary something outside this specification uses or a leftover — and only a person can tell which.

Generated from connectors_grafana v1 · model digest 5a16b14a6f74fe19a54b52e116e508d3918aa3e17aa0fc985cf6283b400eff6f · contract digest slice-sha256/2:02066ca05bbe85fed02cb329217507b10e87a7d3f21e743c8814380db727e554. Do not edit this file; change the specification and regenerate it with ess generate.