Skip to content

armgit / Pulse

Public Imported from GitHub
0

Real-time monitoring dashboard for Proxmox VE, PBS, Docker, Kubernetes, TrueNAS and vSphere. Self-hosted, with alerts for failed backups, full disks, unhealthy containers and offline nodes.

11.5 KB
Raw Blame
import type { ResourceChange } from '@/types/resource';
import type { ResourceChangeKind, ResourceFacetSourceAdapter } from '@/types/resource';
import { humanizeToken } from '@/utils/textPresentation';

export interface ResourceChangeLabelPresentation {
  label: string;
  plural: string;
  className: string;
}

export const RESOURCE_CHANGE_KIND_ORDER: ResourceChangeKind[] = [
  'state_transition',
  'activity',
  'restart',
  'config_update',
  'metric_anomaly',
  'relationship_change',
  'capability_change',
  'alert_fired',
  'alert_acknowledged',
  'alert_unacknowledged',
  'alert_snoozed',
  'alert_unsnoozed',
  'alert_resolved',
  'command_executed',
  'runbook_executed',
];

const RESOURCE_CHANGE_KIND_PRESENTATIONS: Record<
  ResourceChangeKind,
  ResourceChangeLabelPresentation
> = {
  state_transition: {
    label: 'State transition',
    plural: 'State transitions',
    className: 'bg-slate-100 text-slate-700 dark:bg-slate-800 dark:text-slate-300',
  },
  activity: {
    label: 'Activity',
    plural: 'Activities',
    className: 'bg-sky-100 text-sky-700 dark:bg-sky-900/25 dark:text-sky-300',
  },
  restart: {
    label: 'Restart',
    plural: 'Restarts',
    className: 'bg-orange-100 text-orange-700 dark:bg-orange-900 dark:text-orange-300',
  },
  config_update: {
    label: 'Config update',
    plural: 'Config updates',
    className: 'bg-emerald-100 text-emerald-700 dark:bg-emerald-900/25 dark:text-emerald-300',
  },
  metric_anomaly: {
    label: 'Anomaly',
    plural: 'Anomalies',
    className: 'bg-rose-100 text-rose-700 dark:bg-rose-900/25 dark:text-rose-300',
  },
  relationship_change: {
    label: 'Relationship change',
    plural: 'Relationship changes',
    className: 'bg-indigo-100 text-indigo-700 dark:bg-indigo-900/25 dark:text-indigo-300',
  },
  capability_change: {
    label: 'Capability change',
    plural: 'Capability changes',
    className: 'bg-cyan-100 text-cyan-700 dark:bg-cyan-900/25 dark:text-cyan-300',
  },
  alert_fired: {
    label: 'Alert fired',
    plural: 'Alerts fired',
    className: 'bg-rose-100 text-rose-700 dark:bg-rose-900/25 dark:text-rose-300',
  },
  alert_acknowledged: {
    label: 'Alert acknowledged',
    plural: 'Alerts acknowledged',
    className: 'bg-amber-100 text-amber-700 dark:bg-amber-900/25 dark:text-amber-300',
  },
  alert_unacknowledged: {
    label: 'Alert unacknowledged',
    plural: 'Alerts unacknowledged',
    className: 'bg-orange-100 text-orange-700 dark:bg-orange-900 dark:text-orange-300',
  },
  alert_snoozed: {
    label: 'Alert snoozed',
    plural: 'Alerts snoozed',
    className: 'bg-blue-100 text-blue-700 dark:bg-blue-900/25 dark:text-blue-300',
  },
  alert_unsnoozed: {
    label: 'Alert resumed',
    plural: 'Alerts resumed',
    className: 'bg-cyan-100 text-cyan-700 dark:bg-cyan-900/25 dark:text-cyan-300',
  },
  alert_resolved: {
    label: 'Alert resolved',
    plural: 'Alerts resolved',
    className: 'bg-emerald-100 text-emerald-700 dark:bg-emerald-900/25 dark:text-emerald-300',
  },
  command_executed: {
    label: 'Command executed',
    plural: 'Commands executed',
    className: 'bg-slate-100 text-slate-700 dark:bg-slate-800 dark:text-slate-300',
  },
  runbook_executed: {
    label: 'Runbook executed',
    plural: 'Runbooks executed',
    className: 'bg-indigo-100 text-indigo-700 dark:bg-indigo-900/25 dark:text-indigo-300',
  },
};

type ResourceChangeSourceType =
  'platform_event' | 'pulse_diff' | 'heuristic' | 'user_action' | 'agent_action';

export const RESOURCE_CHANGE_SOURCE_TYPE_ORDER: ResourceChangeSourceType[] = [
  'platform_event',
  'pulse_diff',
  'heuristic',
  'user_action',
  'agent_action',
];

const RESOURCE_CHANGE_SOURCE_TYPE_PRESENTATIONS: Record<
  ResourceChangeSourceType,
  ResourceChangeLabelPresentation
> = {
  platform_event: {
    label: 'Platform event',
    plural: 'Platform events',
    className: 'bg-sky-100 text-sky-700 dark:bg-sky-900/25 dark:text-sky-300',
  },
  pulse_diff: {
    label: 'Pulse diff',
    plural: 'Pulse diffs',
    className: 'bg-indigo-100 text-indigo-700 dark:bg-indigo-900/25 dark:text-indigo-300',
  },
  heuristic: {
    label: 'Heuristic',
    plural: 'Heuristics',
    className: 'bg-rose-100 text-rose-700 dark:bg-rose-900/25 dark:text-rose-300',
  },
  user_action: {
    label: 'User action',
    plural: 'User actions',
    className: 'bg-emerald-100 text-emerald-700 dark:bg-emerald-900/25 dark:text-emerald-300',
  },
  agent_action: {
    label: 'Agent action',
    plural: 'Agent actions',
    className: 'bg-amber-100 text-amber-700 dark:bg-amber-900/25 dark:text-amber-300',
  },
};

export const RESOURCE_CHANGE_SOURCE_ADAPTER_ORDER: ResourceFacetSourceAdapter[] = [
  'docker_adapter',
  'proxmox_adapter',
  'truenas_adapter',
  'vmware_adapter',
  'agent:ops-helper',
];

const RESOURCE_CHANGE_SOURCE_ADAPTER_PRESENTATIONS: Record<
  ResourceFacetSourceAdapter,
  ResourceChangeLabelPresentation
> = {
  docker_adapter: {
    label: 'Docker adapter',
    plural: 'Docker adapters',
    className: 'bg-zinc-100 text-zinc-700 dark:bg-zinc-800 dark:text-zinc-300',
  },
  proxmox_adapter: {
    label: 'Proxmox adapter',
    plural: 'Proxmox adapters',
    className: 'bg-sky-100 text-sky-700 dark:bg-sky-900/25 dark:text-sky-300',
  },
  truenas_adapter: {
    label: 'TrueNAS adapter',
    plural: 'TrueNAS adapters',
    className: 'bg-emerald-100 text-emerald-700 dark:bg-emerald-900/25 dark:text-emerald-300',
  },
  vmware_adapter: {
    label: 'VMware adapter',
    plural: 'VMware adapters',
    className: 'bg-cyan-100 text-cyan-700 dark:bg-cyan-900/25 dark:text-cyan-300',
  },
  'agent:ops-helper': {
    label: 'Ops helper',
    plural: 'Ops helpers',
    className: 'bg-amber-100 text-amber-700 dark:bg-amber-900/25 dark:text-amber-300',
  },
};

const humanizeResourceChangeToken = (value: string): string => {
  return humanizeToken(value, { fallback: 'Unknown' });
};

const fallbackResourceChangePresentation = (value: string): ResourceChangeLabelPresentation => {
  const label = humanizeResourceChangeToken(value);
  return {
    label,
    plural: `${label}s`,
    className: 'bg-surface text-muted',
  };
};

export function getResourceChangeKindPresentation(
  kind: ResourceChangeKind | string,
): ResourceChangeLabelPresentation {
  return (
    RESOURCE_CHANGE_KIND_PRESENTATIONS[kind as ResourceChangeKind] ??
    fallbackResourceChangePresentation(String(kind))
  );
}

// Metadata key carrying the reason code of an alert_resolved change whose
// close was not a recovery (unifiedresources.MetadataAlertResolution).
// Ordinary recoveries omit it.
const ALERT_RESOLUTION_METADATA_KEY = 'alert_resolution';

// A close that was not a recovery is neither a live problem nor a healthy
// outcome, so it reads in the same neutral blue as the alert history's
// "moved to agent" badge.
const ALERT_CLOSED_WITHOUT_RECOVERY_CLASS =
  'bg-blue-100 text-blue-700 dark:bg-blue-900/25 dark:text-blue-300';

const ALERT_CLOSED_WITHOUT_RECOVERY_PRESENTATIONS: Record<string, ResourceChangeLabelPresentation> =
  {
    moved_to_agent: {
      label: 'Alert moved',
      plural: 'Alerts moved',
      className: ALERT_CLOSED_WITHOUT_RECOVERY_CLASS,
    },
  };

const ALERT_CLOSED_WITHOUT_RECOVERY_FALLBACK: ResourceChangeLabelPresentation = {
  label: 'Alert closed',
  plural: 'Alerts closed',
  className: ALERT_CLOSED_WITHOUT_RECOVERY_CLASS,
};

/**
 * The reason code of an alert_resolved change that closed without recovering,
 * such as "moved_to_agent" when a node alert moved to its Pulse agent.
 * Undefined for an ordinary recovery and every other kind.
 */
export function getResourceChangeAlertResolution(
  change: Pick<ResourceChange, 'kind' | 'metadata'>,
): string | undefined {
  if (change.kind !== 'alert_resolved') return undefined;
  const reason = change.metadata?.[ALERT_RESOLUTION_METADATA_KEY];
  return typeof reason === 'string' && reason.trim() !== '' ? reason.trim() : undefined;
}

/**
 * Presentation for one change: its kind's, except that an alert close that
 * was not a recovery reads as a move instead of a green "Alert resolved".
 */
export function getResourceChangePresentation(
  change: Pick<ResourceChange, 'kind' | 'metadata'>,
): ResourceChangeLabelPresentation {
  const resolution = getResourceChangeAlertResolution(change);
  if (resolution) {
    return (
      ALERT_CLOSED_WITHOUT_RECOVERY_PRESENTATIONS[resolution] ??
      ALERT_CLOSED_WITHOUT_RECOVERY_FALLBACK
    );
  }
  return getResourceChangeKindPresentation(change.kind);
}

export function getResourceChangeSourceTypePresentation(
  sourceType: ResourceChangeSourceType | string,
): ResourceChangeLabelPresentation {
  return (
    RESOURCE_CHANGE_SOURCE_TYPE_PRESENTATIONS[sourceType as ResourceChangeSourceType] ??
    fallbackResourceChangePresentation(String(sourceType))
  );
}

export function getResourceChangeSourceAdapterPresentation(
  sourceAdapter: ResourceFacetSourceAdapter | string,
): ResourceChangeLabelPresentation {
  return (
    RESOURCE_CHANGE_SOURCE_ADAPTER_PRESENTATIONS[sourceAdapter as ResourceFacetSourceAdapter] ??
    fallbackResourceChangePresentation(String(sourceAdapter))
  );
}

export function formatResourceChangeKind(kind: ResourceChange['kind']): string {
  switch (kind) {
    case 'state_transition':
      return 'State transition';
    case 'activity':
      return 'Activity';
    case 'restart':
      return 'Restart';
    case 'config_update':
      return 'Config update';
    case 'metric_anomaly':
      return 'Metric anomaly';
    case 'relationship_change':
      return 'Relationship change';
    case 'capability_change':
      return 'Capability change';
    case 'alert_fired':
      return 'Alert fired';
    case 'alert_acknowledged':
      return 'Alert acknowledged';
    case 'alert_unacknowledged':
      return 'Alert unacknowledged';
    case 'alert_snoozed':
      return 'Alert snoozed';
    case 'alert_unsnoozed':
      return 'Alert resumed';
    case 'alert_resolved':
      return 'Alert resolved';
    case 'command_executed':
      return 'Command executed';
    case 'runbook_executed':
      return 'Runbook executed';
    default:
      return humanizeToken(String(kind), { fallback: String(kind) });
  }
}

export function formatResourceChangeHeadline(change: ResourceChange): string {
  // The alert engine's account of a close that was not a recovery already
  // says where the alert went, so it is the headline on its own.
  if (getResourceChangeAlertResolution(change)) {
    const reason = change.reason?.trim();
    return reason || `${getResourceChangePresentation(change).label}: ${change.resourceId}`;
  }
  if (change.kind === 'state_transition' && change.from && change.to) {
    return `${formatResourceChangeKind(change.kind)}: ${change.from} → ${change.to}`;
  }
  if (change.kind === 'restart' && change.from && change.to) {
    return `${formatResourceChangeKind(change.kind)}: ${change.from} → ${change.to}`;
  }
  if (change.reason) {
    const kindLabel = formatResourceChangeKind(change.kind);
    const normalizedReason = change.reason.trim();
    if (normalizedReason.toLowerCase().startsWith(`${kindLabel.toLowerCase()}:`)) {
      return normalizedReason;
    }
    return `${kindLabel}: ${normalizedReason}`;
  }
  return `${formatResourceChangeKind(change.kind)}: ${change.resourceId}`;
}

export function sortResourceChangesByObservedAt(
  changes: readonly ResourceChange[],
): ResourceChange[] {
  return [...changes].sort((left, right) => {
    const observedDelta =
      new Date(right.observedAt).getTime() - new Date(left.observedAt).getTime();
    if (observedDelta !== 0) {
      return observedDelta;
    }

    return right.id.localeCompare(left.id);
  });
}