Axiom.Monitor reference

Monitor

Source: src/Axiom/Monitor.ts

An Axiom monitor — a scheduled APL/MPL query that evaluates on a fixed cadence and fires alerts via notifiers when its condition is met.

Three monitor types are supported:

• Threshold — fires when an aggregate result crosses a static threshold (compared with operator).
• MatchEvent — fires for every event matching the query.
• AnomalyDetection — fires when results deviate from a learned baseline by more than tolerance over compareDays.

Changing type triggers a replacement; everything else updates in place.

Monitor: Creating a Monitor

Threshold: alert on >100 errors per 5m

yield* Axiom.Monitor("error-rate", {
  name: "High error rate",
  description: "Fires when error count exceeds 100/5m",
  type: "Threshold",
  aplQuery: `
    ['my-app-traces']
    | where status >= 500
    | summarize count() by bin_auto(_time)
  `,
  operator: "Above",
  threshold: 100,
  intervalMinutes: 5,
  rangeMinutes: 5,
  alertOnNoData: false,
  resolvable: true,
  notifierIds: [slack.id, pagerduty.id],
});

MatchEvent: alert on every panic

yield* Axiom.Monitor("panics", {
  name: "Service panic",
  type: "MatchEvent",
  aplQuery: `['my-app-logs'] | where message contains "panic:"`,
  intervalMinutes: 1,
  rangeMinutes: 1,
  notifierIds: [pagerduty.id],
});

AnomalyDetection: deviation vs. last 7 days

yield* Axiom.Monitor("traffic-anomaly", {
  name: "Traffic anomaly",
  type: "AnomalyDetection",
  aplQuery: `['my-app-traces'] | summarize count() by bin_auto(_time)`,
  compareDays: 7,
  tolerance: 25,             // %
  intervalMinutes: 15,
  rangeMinutes: 15,
  notifierIds: [slack.id],
});

Notifier

Source: src/Axiom/Notifier.ts

An Axiom notifier — an alert destination (Slack, email, PagerDuty, Opsgenie, Discord, Microsoft Teams, generic webhook, or a fully custom webhook with templated body/headers) that monitors target via notifierIds. Exactly one channel under properties should be set.

Notifier: Creating a Notifier

Slack incoming webhook

const slack = yield* Axiom.Notifier("ops-slack", {
  name: "ops-channel",
  properties: {
    slack: { slackUrl: process.env.SLACK_WEBHOOK_URL! },
  },
});

Email distribution list

yield* Axiom.Notifier("ops-email", {
  name: "ops-team",
  properties: { email: { emails: ["sre@example.com", "oncall@example.com"] } },
});

PagerDuty integration

yield* Axiom.Notifier("pagerduty", {
  name: "primary-oncall",
  properties: {
    pagerduty: { routingKey: process.env.PAGERDUTY_ROUTING_KEY!, token: "" },
  },
});

Custom webhook with templated body

yield* Axiom.Notifier("incident-webhook", {
  name: "incident.io",
  properties: {
    customWebhook: {
      url: "https://api.incident.io/v2/alert_events",
      headers: { "Content-Type": "application/json" },
      secretHeaders: { Authorization: `Bearer ${process.env.INCIDENT_TOKEN}` },
      body: '{"title": "{{.Monitor.Name}}", "status": "firing"}',
    },
  },
});