New Metrics Live Activity for Backend Monitoring

Live Activities now support a third activity type: metrics.

Use metrics to track server health, queue pressure, replica lag, worker saturation, and similar backend state you want visible on your lock screen at a glance.

1
const status = await activitysmith.liveActivities.stream("prod-web-1", {
2
  content_state: {
3
    title: "Server Health",
4
    subtitle: "prod-web-1",
5
    type: "metrics",
6
    metrics: [
7
      { label: "CPU", value: 9, unit: "%" },
8
      { label: "MEM", value: 45, unit: "%" },
9
    ],
10
  },
11
});

Call the same PUT /live-activity/stream/{stream_key} endpoint again whenever the values change. ActivitySmith keeps the Live Activity in sync on the device for you.

When the signal is no longer relevant, call DELETE /live-activity/stream/{stream_key} to end the Live Activity.

Need full lifecycle control instead?

If your runtime already has state, you can use the start/update/end lifecycle to have full control over the Live Activity.

1
const start = await activitysmith.liveActivities.start({
2
  content_state: {
3
    title: "Server Health",
4
    subtitle: "prod-web-1",
5
    type: "metrics",
6
    metrics: [
7
      { label: "CPU", value: 76, unit: "%" },
8
      { label: "MEM", value: 52, unit: "%" },
9
    ],
10
  },
11
});
12
13
const activityId = start.activity_id;

Store the returned activity_id and use the same metrics shape in update and end requests.

1
await activitysmith.liveActivities.update({
2
  activity_id: activityId,
3
  content_state: {
4
    ...
5
  },
6
});

Availability

Available now across the API, SDKs, CLI, and GitHub Action.

This feature is available in the ActivitySmith iOS app version 1.5.0 and newer.