frigate/web/src/hooks/use-stats.ts

import { FrigateConfig } from "@/types/frigateConfig";
import {
  CameraDetectThreshold,
  CameraFfmpegThreshold,
  InferenceThreshold,
} from "@/types/graph";
import { FrigateStats, PotentialProblem, ProblemSeverity } from "@/types/stats";
import { useMemo } from "react";
import useSWR from "swr";
import useDeepMemo from "./use-deep-memo";
import { capitalizeAll, capitalizeFirstLetter } from "@/utils/stringUtil";
import { isReplayCamera } from "@/utils/cameraUtil";
import { useFrigateStats, useJobStatus } from "@/api/ws";
import { useIsAdmin } from "./use-is-admin";

import { useTranslation } from "react-i18next";

// the status bar has always rendered these exact classes; keep them byte for
// byte so its output does not change
const SEVERITY_COLOR: Record<ProblemSeverity, string> = {
  error: "text-danger",
  warning: "text-orange-400",
  info: "text-selected",
};

function problem(
  severity: ProblemSeverity,
  text: string,
  relevantLink?: string,
): PotentialProblem {
  return { text, severity, color: SEVERITY_COLOR[severity], relevantLink };
}

export default function useStats(stats: FrigateStats | undefined) {
  const { t } = useTranslation(["views/system"]);
  const { data: config } = useSWR<FrigateConfig>("config");
  const isAdmin = useIsAdmin();

  // Pass isAdmin as revalidateOnFocus so non-admins never send the jobState snapshot pull
  const { payload: replayJob } = useJobStatus("debug_replay", isAdmin);
  const replayActive = Boolean(
    isAdmin &&
      replayJob &&
      (replayJob.status === "queued" ||
        replayJob.status === "running" ||
        replayJob.status === "success"),
  );

  const memoizedStats = useDeepMemo(stats);

  const potentialProblems = useMemo<PotentialProblem[]>(() => {
    const problems: PotentialProblem[] = [];

    if (!memoizedStats) {
      return problems;
    }

    // if frigate has just started
    // don't look for issues
    if (memoizedStats.service.uptime < 120) {
      return problems;
    }

    // check shm level
    const shm = memoizedStats.service.storage["/dev/shm"];
    if (shm?.total && shm?.min_shm && shm.total < shm.min_shm) {
      problems.push(
        problem(
          "error",
          t("stats.shmTooLow", {
            total: shm.total,
            min: shm.min_shm,
          }),
          "/system#storage",
        ),
      );
    }

    // check detectors for high inference speeds
    Object.entries(memoizedStats["detectors"]).forEach(([key, det]) => {
      if (det["inference_speed"] > InferenceThreshold.error) {
        problems.push(
          problem(
            "error",
            t("stats.detectIsVerySlow", {
              detect: capitalizeFirstLetter(key),
              speed: det["inference_speed"],
            }),
            "/system#general",
          ),
        );
      } else if (det["inference_speed"] > InferenceThreshold.warning) {
        problems.push(
          problem(
            "warning",
            t("stats.detectIsSlow", {
              detect: capitalizeFirstLetter(key),
              speed: det["inference_speed"],
            }),
            "/system#general",
          ),
        );
      }
    });

    // check for offline cameras
    Object.entries(memoizedStats["cameras"]).forEach(([name, cam]) => {
      if (!config) {
        return;
      }

      // Skip replay cameras
      if (isReplayCamera(name)) {
        return;
      }

      const cameraName = config.cameras?.[name]?.friendly_name ?? name;
      if (config.cameras?.[name]?.enabled && cam["camera_fps"] == 0) {
        problems.push(
          problem(
            "error",
            t("stats.cameraIsOffline", {
              camera: capitalizeFirstLetter(capitalizeAll(cameraName)),
            }),
            "logs",
          ),
        );
      }
    });

    // check camera cpu usages
    Object.entries(memoizedStats["cameras"]).forEach(([name, cam]) => {
      // Skip replay cameras
      if (isReplayCamera(name)) {
        return;
      }

      const ffmpegAvg = parseFloat(
        memoizedStats["cpu_usages"][cam["ffmpeg_pid"]]?.cpu_average,
      );
      const detectAvg = parseFloat(
        memoizedStats["cpu_usages"][cam["pid"]]?.cpu_average,
      );

      const cameraName = config?.cameras?.[name]?.friendly_name ?? name;

      if (config?.cameras?.[name]?.enabled && cam["skipped_fps"] > 1) {
        problems.push(
          problem(
            "warning",
            t("stats.cameraSkippedDetections", {
              camera: capitalizeFirstLetter(capitalizeAll(cameraName)),
              fps: cam["skipped_fps"],
            }),
            "/system#cameras",
          ),
        );
      }

      if (!isNaN(ffmpegAvg) && ffmpegAvg >= CameraFfmpegThreshold.error) {
        problems.push(
          problem(
            "error",
            t("stats.ffmpegHighCpuUsage", {
              camera: capitalizeFirstLetter(capitalizeAll(cameraName)),
              ffmpegAvg,
            }),
            "/system#cameras",
          ),
        );
      }

      if (!isNaN(detectAvg) && detectAvg >= CameraDetectThreshold.error) {
        problems.push(
          problem(
            "error",
            t("stats.detectHighCpuUsage", {
              camera: capitalizeFirstLetter(capitalizeAll(cameraName)),
              detectAvg,
            }),
            "/system#cameras",
          ),
        );
      }
    });

    // Add message if debug replay is active
    if (replayActive) {
      problems.push(
        problem(
          "info",
          t("stats.debugReplayActive", {
            defaultValue: "Debug replay session is active",
          }),
          "/replay",
        ),
      );
    }

    return problems;
  }, [config, memoizedStats, t, replayActive]);

  return { potentialProblems };
}

export function useAutoFrigateStats() {
  const { data: initialStats } = useSWR<FrigateStats>("stats", {
    revalidateOnFocus: false,
  });
  const latestStats = useFrigateStats();

  const stats = useMemo(() => {
    if (latestStats) {
      return latestStats;
    }

    return initialStats;
  }, [initialStats, latestStats]);

  return stats;
}