Skip to content

Open-source status page, incident response and uptime monitoring

8.6 KB
Raw Blame
"use client";

import type { RouterOutputs } from "@openstatus/api";
import { monitorRegions } from "@openstatus/db/src/schema/constants";

import type { MetricCard } from "../components/content/metric-card";
import { formatDateTime, formatMilliseconds } from "../lib/formatter";
import type { RegionMetric } from "./region-metrics";
import type { Region } from "./regions";

export const STATUS = ["success", "error", "degraded"] as const;
export const PERIODS = ["1d", "7d", "14d"] as const;
export const REGIONS =
  monitorRegions as unknown as (typeof monitorRegions)[number][];
export const PERCENTILES = ["p50", "p75", "p90", "p95", "p99"] as const;
export const INTERVALS = [5, 15, 30, 60, 120, 240, 480, 1440] as const;
export const TRIGGER = ["api", "cron"] as const;

const PERCENTILE_MAP = {
  p50: "p50Latency",
  p75: "p75Latency",
  p90: "p90Latency",
  p95: "p95Latency",
  p99: "p99Latency",
} as const;

// FIXME: rename pipe return values

export function mapMetrics(metrics: RouterOutputs["tinybird"]["metrics"]) {
  return metrics.data?.map((metric) => {
    return {
      p50: metric.p50Latency,
      p75: metric.p75Latency,
      p90: metric.p90Latency,
      p95: metric.p95Latency,
      p99: metric.p99Latency,
      total: metric.count,
      uptime: (metric.success + metric.degraded) / metric.count,
      degraded: metric.degraded,
      error: metric.error,
      lastTimestamp: metric.lastTimestamp,
    };
  });
}

export const metricsCards = {
  uptime: {
    label: "UPTIME",
    variant: "success",
  },
  degraded: {
    label: "DEGRADED",
    variant: "warning",
  },
  error: {
    label: "FAILING",
    variant: "destructive",
  },
  total: {
    label: "REQUESTS",
    variant: "default",
  },
  lastTimestamp: {
    label: "LAST CHECKED",
    variant: "ghost",
  },
  p50: {
    label: "P50",
    variant: "default",
  },
  p75: {
    label: "P75",
    variant: "default",
  },
  p90: {
    label: "P90",
    variant: "default",
  },
  p95: {
    label: "P95",
    variant: "default",
  },
  p99: {
    label: "P99",
    variant: "default",
  },
} as const satisfies Record<
  keyof ReturnType<typeof mapMetrics>[number],
  {
    label: string;
    variant: React.ComponentProps<typeof MetricCard>["variant"];
  }
>;

export function mapUptime(status: RouterOutputs["tinybird"]["uptime"]) {
  return status.data
    .map((status) => {
      return {
        ...status,
        ok: status.success,
        interval: formatDateTime(status.interval),
        total: status.success + status.error + status.degraded,
      };
    })
    .reverse();
}

/**
 * Transform Tinybird `metricsRegions` response into RegionMetric[] for UI.
 */
export function mapRegionMetrics(
  timeline: RouterOutputs["tinybird"]["metricsRegions"] | undefined,
  regions: Region[],
  percentile: (typeof PERCENTILES)[number],
): RegionMetric[] {
  if (!timeline)
    return (regions
      .sort((a, b) => a.localeCompare(b))
      .map((region) => ({
        region,
        p50: 0,
        p90: 0,
        p99: 0,
        trend: [] as {
          latency: number;
          timestamp: number;
          [key: string]: number;
        }[],
      })) ?? []) as RegionMetric[];

  type TimelineRow = (typeof timeline.data)[number];

  const map = new Map<
    Region,
    {
      region: Region;
      p50: number;
      p90: number;
      p99: number;
      trend: {
        latency: number;
        timestamp: number;
        [key: string]: number;
      }[];
    }
  >();

  (timeline.data as TimelineRow[])
    .filter((row) => regions.includes(row.region as Region))
    .sort((a, b) => a.region.localeCompare(b.region))
    .forEach((row) => {
      const region = row.region as Region;
      const entry = map.get(region) ?? {
        region,
        p50: 0,
        p90: 0,
        p99: 0,
        trend: [],
      };

      entry.trend.push({
        latency: row[PERCENTILE_MAP[percentile]] ?? 0,
        timestamp: row.timestamp,
        [region]: row[PERCENTILE_MAP[percentile]] ?? 0,
      });

      entry.p50 += row.p50Latency ?? 0;
      entry.p90 += row.p90Latency ?? 0;
      entry.p99 += row.p99Latency ?? 0;

      map.set(region, entry);
    });

  map.forEach((entry) => {
    const count = entry.trend.length || 1;
    entry.trend.reverse();
    entry.p50 = Math.round(entry.p50 / count);
    entry.p90 = Math.round(entry.p90 / count);
    entry.p99 = Math.round(entry.p99 / count);
  });

  return Array.from(map.values()) as RegionMetric[];
}

export function mapGlobalMetrics(
  metrics: RouterOutputs["tinybird"]["globalMetrics"],
) {
  return metrics.data?.map((metric) => {
    return {
      p50: metric.p50Latency,
      p75: metric.p75Latency,
      p90: metric.p90Latency,
      p95: metric.p95Latency,
      p99: metric.p99Latency,
      total: metric.count,
      monitorId: metric.monitorId,
    };
  });
}

export type MonitorListMetric = {
  title: string;
  key: "degraded" | "error" | "active" | "inactive" | "p95";
  value: number | string | undefined;
  variant: React.ComponentProps<typeof MetricCard>["variant"];
};

export const globalCards = [
  "active",
  "degraded",
  "error",
  "inactive",
  "p95",
] as const;

export const metricsGlobalCards: Record<
  (typeof globalCards)[number],
  {
    title: string;
    key: (typeof globalCards)[number];
  }
> = {
  active: {
    title: "Normal",
    key: "active" as const,
  },
  degraded: {
    title: "Degraded",
    key: "degraded" as const,
  },
  error: {
    title: "Failing",
    key: "error" as const,
  },
  inactive: {
    title: "Inactive",
    key: "inactive" as const,
  },
  p95: {
    title: "Slowest P95",
    key: "p95" as const,
  },
};

/**
 * Build the metric cards data that is shown on the monitors list page.
 */
export function getMonitorListMetrics(
  monitors: RouterOutputs["monitor"]["list"] = [],
  data: {
    p95Latency: number;
    monitorId: string;
  }[] = [],
): readonly MonitorListMetric[] {
  const variantMap: Record<
    (typeof globalCards)[number],
    React.ComponentProps<typeof MetricCard>["variant"]
  > = {
    active: "success",
    degraded: "warning",
    error: "destructive",
    inactive: "default",
    p95: "ghost",
  } as const;

  return globalCards.map((key) => {
    let value: number | string | undefined;
    switch (key) {
      case "active":
        value = monitors.filter(
          (m) => m.status === "active" && m.active,
        ).length;
        break;
      case "degraded":
        value = monitors.filter(
          (m) => m.status === "degraded" && m.active,
        ).length;
        break;
      case "error":
        value = monitors.filter((m) => m.status === "error" && m.active).length;
        break;
      case "inactive":
        value = monitors.filter((m) => m.active === false).length;
        break;
      case "p95":
        const p95 = data.sort((a, b) => b.p95Latency - a.p95Latency)[0]
          ?.p95Latency;
        value = p95 ? formatMilliseconds(p95) : "N/A";
        break;
    }

    return {
      title: metricsGlobalCards[key].title,
      key,
      value,
      variant: variantMap[key],
    } as const;
  }) as readonly MonitorListMetric[];
}

export function mapLatency(
  latency: RouterOutputs["tinybird"]["metricsLatency"],
  percentile: (typeof PERCENTILES)[number],
) {
  return latency.data?.map((metric) => {
    return {
      timestamp: formatDateTime(new Date(metric.timestamp)),
      latency: metric[PERCENTILE_MAP[percentile]],
    };
  });
}

// Reduce each public monitor's latency time-series to a single averaged
// percentile, keyed by monitorId — for the status-page tracker latency chip.
export function latencyByMonitorId(
  monitors: RouterOutputs["statusPage"]["getMonitors"] = [],
  percentile: (typeof PERCENTILES)[number] = "p75",
) {
  const field = PERCENTILE_MAP[percentile];
  const map = new Map<string, string>();
  for (const monitor of monitors ?? []) {
    const points =
      monitor.data
        ?.map((metric) => metric[field])
        .filter((value): value is number => value != null) ?? [];
    if (points.length === 0) continue;
    const avg = points.reduce((sum, value) => sum + value, 0) / points.length;
    // compact chip: drop the unit space ("117 ms" -> "117ms")
    map.set(monitor.id.toString(), formatMilliseconds(avg).replace(" ", ""));
  }
  return map;
}

export function mapTimingPhases(
  timingPhases: RouterOutputs["tinybird"]["metricsTimingPhases"],
  percentile: (typeof PERCENTILES)[number],
) {
  return timingPhases.data?.map((metric) => {
    return {
      timestamp: formatDateTime(new Date(metric.timestamp)),
      dns: metric[`${percentile}Dns`],
      ttfb: metric[`${percentile}Ttfb`],
      transfer: metric[`${percentile}Transfer`],
      connect: metric[`${percentile}Connect`],
      tls: metric[`${percentile}Tls`],
    };
  });
}