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.

12.8 KB
Raw Blame
import type { SystemConfig } from '@/types/config';
import { apiFetchJSON } from '@/utils/apiClient';

export interface SystemSettingsResponse extends SystemConfig {
  envOverrides?: Record<string, boolean>;
}

export interface TelemetryPingPreview {
  schema_version: number;
  sent_at: string;
  install_id: string;
  version: string;
  version_raw?: string;
  version_channel: string;
  version_build?: string;
  version_is_development: boolean;
  version_is_published_release: boolean;
  platform: string;
  os: string;
  arch: string;
  event: string;
  deployment_method: string;
  known_install_age_bucket: string;
  activation_stage: string;
  time_to_first_monitored_resource_bucket: string;
  estate_size_bucket: string;
  auth_configured: boolean;
  configured_connections: number;
  monitoring_active: boolean;
  outcome_observed_30d: boolean;
  pve_nodes: number;
  pbs_instances: number;
  pmg_instances: number;
  vms: number;
  containers: number;
  agent_hosts: number;
  docker_hosts: number;
  docker_containers: number;
  kubernetes_clusters: number;
  kubernetes_nodes: number;
  kubernetes_pods: number;
  kubernetes_deployments: number;
  storage_pools: number;
  physical_disks: number;
  ceph_clusters: number;
  network_shares: number;
  truenas_systems: number;
  truenas_vms: number;
  truenas_apps: number;
  vmware_hosts: number;
  vmware_vms: number;
  vmware_datastores: number;
  availability_targets: number;
  availability_probe_targets: number;
  availability_probe_agents: number;
  ai_enabled: boolean;
  patrol_enabled: boolean;
  discovery_enabled: boolean;
  notifications_enabled: boolean;
  ai_actions_enabled: boolean;
  alert_ai_enabled: boolean;
  ai_provider_class: string;
  active_alerts: number;
  relay_enabled: boolean;
  sso_enabled: boolean;
  multi_tenant: boolean;
  paid_license: boolean;
  has_api_tokens: boolean;
  rbac_custom_roles: number;
  rbac_user_assignments: number;
  audit_reads_30d: number;
  report_schedules: number;
  report_schedules_enabled: number;
  report_schedules_run_30d: number;
  agent_profiles: number;
  update_attempts_30d: number;
  update_successes_30d: number;
  update_failures_30d: number;
  update_last_failure_category?: string;
  update_channel: string;
  update_check_outcome: string;
  update_available: boolean;
  service_health_observed: boolean;
  service_health_healthy: boolean;
  service_health_failure_category?: string;
  service_health_cohort?: string;
  service_health_previous_version?: string;
  service_health_previous_observed: boolean;
  service_health_previous_healthy: boolean;
  node_test_attempts_30d: number;
  node_test_failures_30d: number;
  successful_history_reads_over_7d_30d: number;
  workload_history_preview_sessions_30d: number;
  workload_history_scrub_sessions_30d: number;
  workload_history_range_change_sessions_30d: number;
  workload_history_details_selection_sessions_30d: number;
  alerts_fired_30d: number;
  alerts_acknowledged_30d: number;
  alerts_resolved_30d: number;
  // Coarse lifecycle aggregates only: no alert text, resource identity, or tenant identity.
  active_alerts_info: number;
  active_alerts_warning: number;
  active_alerts_critical: number;
  active_alerts_age_under_1h: number;
  active_alerts_age_1h_24h: number;
  active_alerts_age_1d_7d: number;
  active_alerts_age_7d_plus: number;
  alerts_fired_info_30d: number;
  alerts_fired_warning_30d: number;
  alerts_fired_critical_30d: number;
  alerts_resolved_info_30d: number;
  alerts_resolved_warning_30d: number;
  alerts_resolved_critical_30d: number;
  alerts_resolution_under_15m_30d: number;
  alerts_resolution_15m_1h_30d: number;
  alerts_resolution_1h_24h_30d: number;
  alerts_resolution_1d_7d_30d: number;
  alerts_resolution_7d_plus_30d: number;
  alerts_repeat_occurrences_30d: number;
  alerts_snoozed_occurrences_30d: number;
  alerts_resolved_while_snoozed_30d: number;
  alert_manager_tenants: number;
  alert_delivery_active_tenants: number;
  alert_flapping_enabled_tenants: number;
  alert_intent_policy_configured_tenants: number;
  alert_event_history_authoritative_tenants: number;
  alert_active_state_authoritative_tenants: number;
  alert_active_state_persistence_degraded_tenants: number;
  notification_attempts_7d: number;
  notification_deliveries_7d: number;
  notification_failures_7d: number;
  notification_failures_authentication_7d: number;
  notification_failures_rate_limited_7d: number;
  notification_failures_connectivity_7d: number;
  notification_failures_tls_7d: number;
  notification_failures_configuration_7d: number;
  notification_failures_rejected_7d: number;
  notification_failures_server_error_7d: number;
  notification_failures_unknown_7d: number;
  pulse_intelligence_loop_configured: boolean;
  pulse_intelligence_loop_active_30d: boolean;
  pulse_intelligence_complete_operations_loop_30d: boolean;
  pulse_intelligence_approved_execution_loop_30d: boolean;
  pulse_intelligence_resolved_operations_loop_30d: boolean;
  pulse_intelligence_patrol_control_completed_operations_loop_30d: boolean;
  pulse_intelligence_patrol_control_resolved_operations_loop_30d: boolean;
  pulse_intelligence_patrol_control_paid_completed_operations_loop_30d: boolean;
  pulse_intelligence_patrol_control_paid_resolved_operations_loop_30d: boolean;
  pulse_intelligence_pro_activation_completed_operations_loop_30d: boolean;
  pulse_intelligence_pro_activation_resolved_operations_loop_30d: boolean;
  pulse_intelligence_pro_activation_paid_completed_operations_loop_30d: boolean;
  pulse_intelligence_pro_activation_paid_resolved_operations_loop_30d: boolean;
  pulse_intelligence_governed_action_active_30d: boolean;
  pulse_intelligence_assistant_operations_loop_30d: boolean;
  pulse_intelligence_assistant_approved_execution_loop_30d: boolean;
  pulse_intelligence_assistant_approved_action_success_loop_30d: boolean;
  pulse_intelligence_assistant_resolved_operations_loop_30d: boolean;
  pulse_intelligence_external_agent_operations_loop_30d: boolean;
  pulse_intelligence_external_agent_approved_execution_loop_30d: boolean;
  pulse_intelligence_external_agent_approved_action_success_loop_30d: boolean;
  pulse_intelligence_external_agent_resolved_operations_loop_30d: boolean;
  pulse_intelligence_mcp_adapter_operations_loop_30d: boolean;
  pulse_intelligence_mcp_adapter_approved_execution_loop_30d: boolean;
  pulse_intelligence_mcp_adapter_approved_action_success_loop_30d: boolean;
  pulse_intelligence_mcp_adapter_resolved_operations_loop_30d: boolean;
  pulse_intelligence_operations_loop_starter_requests_30d: number;
  pulse_intelligence_assistant_operations_loop_starter_requests_30d: number;
  pulse_intelligence_patrol_operations_loop_starter_requests_30d: number;
  pulse_intelligence_patrol_control_operations_loop_starter_requests_30d: number;
  pulse_intelligence_pro_activation_operations_loop_starter_requests_30d: number;
  pulse_intelligence_mcp_operations_loop_starter_requests_30d: number;
  pulse_intelligence_assistant_ai_calls_30d: number;
  pulse_intelligence_assistant_context_ai_calls_30d: number;
  pulse_intelligence_assistant_tool_calls_30d: number;
  pulse_intelligence_patrol_ai_calls_30d: number;
  pulse_intelligence_patrol_runs_30d: number;
  pulse_intelligence_patrol_new_findings_30d: number;
  pulse_intelligence_patrol_investigations_30d: number;
  pulse_intelligence_patrol_resolved_findings_30d: number;
  pulse_intelligence_patrol_blocked_cause?: string;
  pulse_intelligence_patrol_autonomy_level: string;
  pulse_intelligence_patrol_input_tokens_bucket_30d: string;
  pulse_intelligence_patrol_output_tokens_bucket_30d: string;
  pulse_intelligence_patrol_investigation_outcome_fix_verified_30d: number;
  pulse_intelligence_patrol_investigation_outcome_fix_queued_30d: number;
  pulse_intelligence_patrol_investigation_outcome_fix_executed_30d: number;
  pulse_intelligence_patrol_investigation_outcome_fix_rejected_30d: number;
  pulse_intelligence_patrol_investigation_outcome_fix_failed_30d: number;
  pulse_intelligence_patrol_investigation_outcome_fix_verification_unknown_30d: number;
  pulse_intelligence_patrol_investigation_outcome_resolved_30d: number;
  pulse_intelligence_patrol_investigation_outcome_needs_attention_30d: number;
  pulse_intelligence_patrol_investigation_outcome_cannot_fix_30d: number;
  pulse_intelligence_patrol_investigation_outcome_timed_out_30d: number;
  pulse_intelligence_patrol_investigation_outcome_in_progress_30d: number;
  pulse_intelligence_patrol_investigation_outcome_failed_30d: number;
  pulse_intelligence_patrol_investigation_outcome_other_30d: number;
  pulse_intelligence_external_agent_enabled: boolean;
  pulse_intelligence_external_agent_used_30d: boolean;
  pulse_intelligence_mcp_adapter_used_30d: boolean;
  pulse_intelligence_external_agent_context_requests_30d: number;
  pulse_intelligence_external_agent_event_stream_requests_30d: number;
  pulse_intelligence_external_agent_history_read_days_30d: number;
  pulse_intelligence_external_agent_provisioning_requests_30d: number;
  pulse_intelligence_external_agent_operator_state_requests_30d: number;
  pulse_intelligence_external_agent_finding_requests_30d: number;
  pulse_intelligence_external_agent_action_requests_30d: number;
  pulse_intelligence_action_plans_30d: number;
  pulse_intelligence_approval_requests_30d: number;
  pulse_intelligence_rejected_action_decisions_30d: number;
  pulse_intelligence_approved_action_decisions_30d: number;
  pulse_intelligence_approved_action_attempts_30d: number;
  pulse_intelligence_approved_action_successes_30d: number;
  pulse_intelligence_patrol_action_plans_30d: number;
  pulse_intelligence_patrol_approval_requests_30d: number;
  pulse_intelligence_patrol_rejected_action_decisions_30d: number;
  pulse_intelligence_patrol_approved_action_decisions_30d: number;
  pulse_intelligence_patrol_approved_action_attempts_30d: number;
  pulse_intelligence_patrol_approved_action_successes_30d: number;
  pulse_intelligence_approved_action_failures_pre_dispatch_30d: number;
  pulse_intelligence_approved_action_failures_execution_30d: number;
  pulse_intelligence_approved_action_failures_unverified_30d: number;
  pulse_intelligence_approved_action_stuck_executing_30d: number;
  pulse_intelligence_approved_action_in_flight_30d: number;
  pulse_intelligence_approved_action_unclassified_30d: number;
  pulse_intelligence_approved_action_refusals_plan_stale_30d: number;
  pulse_intelligence_approved_action_refusals_policy_30d: number;
  pulse_intelligence_approved_action_refusals_capability_30d: number;
  pulse_intelligence_approved_action_refusals_target_changed_30d: number;
  pulse_intelligence_approved_action_refusals_prerequisite_30d: number;
  pulse_intelligence_approved_action_refusals_contract_30d: number;
  pulse_intelligence_approved_action_refusals_other_30d: number;
  pulse_intelligence_approved_action_refusals_uncoded_30d: number;
  pulse_intelligence_verified_finding_resolutions_30d: number;
  pulse_intelligence_approved_action_last_failure_reason_30d?: string;
}

export interface TelemetryPreviewResponse {
  enabled: boolean;
  payload: TelemetryPingPreview;
}

export interface RuntimeBrandingResponse {
  enabled: boolean;
  displayName: string;
  logoDataUrl: string;
}

/**
 * Presentation-only system defaults available to every authenticated session.
 * This intentionally excludes the admin-only system settings payload.
 */
export interface RuntimeDisplayResponse {
  theme?: string;
  fullWidthMode?: boolean;
  disableDockerUpdateActions?: boolean;
  telemetryEnabled?: boolean;
  reduceProUpsellNoise?: boolean;
  /** Effective PVE polling cadence in seconds. */
  pvePollingInterval?: number;
}

export class SettingsAPI {
  private static baseUrl = '/api';

  // System settings update (preferred) - uses SystemConfig type from config.ts
  static async updateSystemSettings(settings: Partial<SystemConfig>): Promise<void> {
    await apiFetchJSON(`${this.baseUrl}/system/settings/update`, {
      method: 'POST',
      body: JSON.stringify(settings),
    });
  }

  // Get system settings - returns SystemConfig
  static async getSystemSettings(): Promise<SystemSettingsResponse> {
    return apiFetchJSON(`${this.baseUrl}/system/settings`) as Promise<SystemSettingsResponse>;
  }

  static async getRuntimeBranding(): Promise<RuntimeBrandingResponse> {
    return apiFetchJSON(`${this.baseUrl}/runtime/branding`) as Promise<RuntimeBrandingResponse>;
  }

  static async getRuntimeDisplay(): Promise<RuntimeDisplayResponse> {
    return apiFetchJSON(`${this.baseUrl}/runtime/display`) as Promise<RuntimeDisplayResponse>;
  }

  static async getTelemetryPreview(): Promise<TelemetryPreviewResponse> {
    return apiFetchJSON(
      `${this.baseUrl}/system/settings/telemetry-preview`,
    ) as Promise<TelemetryPreviewResponse>;
  }

  static async resetTelemetryInstallID(): Promise<TelemetryPreviewResponse> {
    return apiFetchJSON(`${this.baseUrl}/system/settings/telemetry-reset-id`, {
      method: 'POST',
    }) as Promise<TelemetryPreviewResponse>;
  }
}