Alarm

A cloud metric alarm attached to an instance.

Receives state updates via webhooks from AWS CloudWatch, Azure Monitor, GCP Cloud Monitoring, or Prometheus Alertmanager.

Check currentState to see whether the alarm is firing. A null currentState means no state has been reported yet for this alarm.

type Alarm {
  id: ID!
  displayName: String!
  cloudResourceId: String!
  comparisonOperator: String
  threshold: Float
  period: Int
  metric: AlarmMetric
  currentState: AlarmState
  createdAt: DateTime!
  updatedAt: DateTime!
}

Fields

Alarm.id ● ID! non-null scalar {#id}

Unique identifier for this alarm.

Alarm.displayName ● String! non-null scalar {#display-name}

Human-readable name for the alarm, set by the cloud provider when the alarm was registered.

Alarm.cloudResourceId ● String! non-null scalar {#cloud-resource-id}

The cloud provider's unique identifier for the alarm (e.g., CloudWatch AlarmArn, GCP alert policy name, Azure alert id).

Alarm.comparisonOperator ● String scalar {#comparison-operator}

How the metric is compared against threshold (e.g., GREATER_THAN, LESS_THAN, GREATER_THAN_OR_EQUAL_TO, LESS_THAN_OR_EQUAL_TO). May be null for Alertmanager and GCP alarms.

Alarm.threshold ● Float scalar {#threshold}

The value crossed to trigger the alarm, compared using comparisonOperator. May be null for Alertmanager alarms and some GCP conditions.

Alarm.period ● Int scalar {#period}

Evaluation window in seconds over which the metric is aggregated before the comparison is applied. May be null for alarms ingested from providers that don't expose a period.

Alarm.metric ● AlarmMetric object {#metric}

The cloud metric this alarm evaluates. May be null for alarms from providers that don't supply structured metric data (e.g., Alertmanager).

Alarm.currentState ● AlarmState object {#current-state}

The most recent state reported for this alarm. null indicates no state has been recorded yet.

Alarm.createdAt ● DateTime! non-null scalar {#created-at}

When this alarm was registered with Massdriver (UTC).

Alarm.updatedAt ● DateTime! non-null scalar {#updated-at}

When this alarm's configuration last changed (UTC).

Returned By

instanceAlarm query

Member Of

AlarmEvent object ● AlarmPayload object ● AlarmsPage object