Skip to main content

Glossary

A reference of all domain terms used across Proxima Console.

Infrastructure & Inventory

TermDefinition
AgentA lightweight Go binary deployed on a managed server or Kubernetes node. Agents have their own identity in the agents table (created at enrollment) separate from the host record. Agent types: host (collects server inventory, metrics, processes, logs, changes) and collector (collects Kubernetes cluster inventory without creating a host record). Each agent is identified by a UUID (agent_id) used in NATS subjects and JWT naming (agent-{uuid}).
ClientA managed customer account representing a distinct organization whose infrastructure is monitored by Proxima Console.
EnvironmentA deployment environment (e.g., production, staging) within a client. Used to organize hosts and apply environment-level configurations.
HostAn infrastructure record in the hosts table representing a server. Created by the InventoryWorker on first inventory message from a host-type agent — not during enrollment. Stores inventory details (OS, hardware, IP), agent status, and configuration metadata. The agent_id column links the host row to its owning agent in the agents table.
Host StatusThe agent's connectivity state: online, offline, or stale (last seen exceeds threshold).
InventoryComplete snapshot of a host's static configuration: OS, hardware, packages, services, network interfaces, users, cron jobs, firewall rules, certificates, kernel modules, and security settings.
CollectorA metrics collector plugin (PostgreSQL, Nginx, Docker). Discoverable at runtime and enabled/disabled per host.
LabelA key-value tag applied to a host. Labels are static (stored in YAML/env) or dynamic (computed via shell command on a schedule). Sent with every heartbeat and inventory snapshot.
TagA user-defined key=value annotation on an entity (host, environment, client). Managed via the API.
ProcessA running process on a host with CPU/memory usage, command line, user context, and parent-child relationships.
ServiceA discovered service on a host (e.g., nginx, postgresql) with version, status, listen ports, and configuration path.
Database (asset type)CMDB asset type for database instances (PostgreSQL, MySQL) discovered via agent integrations. Auto-created from heartbeat integration sync.
Database ClusterLogical grouping of primary + replica database instances, detected automatically from PostgreSQL replication topology.
Cache (asset type)CMDB asset type for cache instances (Redis, Memcached) discovered via agent integrations. Auto-created from heartbeat integration sync.
Web Server (asset type)CMDB asset type for web server instances (Nginx) discovered via agent integrations. Auto-created from heartbeat integration sync.
Container Runtime (asset type)CMDB asset type for container runtimes (Docker) discovered via agent integrations. Auto-created from heartbeat integration sync.
PackageAn installed software package on a host, tracked by package manager (apt, yum, etc.).
CredentialEncrypted credentials (passwords, API keys, tokens) stored per client/environment and referenced by collectors or integrations.
Install TokenA reusable token for agent enrollment. Has a TTL, optional max-use limit, client scope, and use count tracking. Enrollment creates an agent record (agents table) — not a host record.

Metrics & Observability

TermDefinition
MetricA single time-series data point (timestamp, host_id, metric_name, value, labels) stored in VictoriaMetrics.
VictoriaMetricsTime-series database for metrics storage with native multi-tenancy (one VM account per client).
MetricsQLVictoriaMetrics' query language used to retrieve and aggregate metrics.
LiteLLMLLM gateway for multi-provider routing, used to proxy AI Chat requests to Claude and other language models.
Metric AnnotationA user-created text note on a metrics chart (host or environment scope) with a timestamp and creator.
Metrics WorkerA NATS consumer that processes telemetry messages and writes metrics to VictoriaMetrics with tenant isolation.
Alert GroupDeduplicated collection of related alerts grouped by fingerprint, with lifecycle states (firing, acknowledged, resolved).
Alert CorrelationAutomatic enrichment of alert groups with metrics snapshots, recent changes, related alerts, and compliance context.

Healthchecks & Scanning

TermDefinition
Healthcheck RuleA single compliance check (security, patch, operational) with a slug, name, severity, and source. Can come from Lynis, OpenSCAP, Trivy, or custom checks.
Healthcheck CategoryA grouping of related healthcheck rules (e.g., "Security", "Patching").
Healthcheck RunOne execution of a healthcheck scan on a host. Records total/passed/failed/skipped counts, score, and duration.
Healthcheck ResultOne check result within a run. Links to a rule, host, and status (pass/fail/skip/warning).
ScannerA tool that performs healthchecks: Lynis (security audit), OpenSCAP (compliance scanning), Trivy (vulnerability scanning), or custom scripts.
Scanner FindingA detailed finding from a scanner (CVE, XCCDF rule violation) with severity, title, status, and metadata.

Compliance

TermDefinition
FrameworkA collection of compliance controls grouped under a standard (e.g., "Proxima Best Practices"). Can be builtin (shipped with Proxima) or custom (user-defined). Has configurable score thresholds.
ControlAn individual compliance requirement within a framework (e.g., "SSH access hardened"). Has a code, title, category, severity, and type.
Control TypeHow a control is evaluated: automated (from scanner evidence), manual (requires human attestation), or hybrid (both).
Control CategoryGrouping for controls: security, patch_and_vuln, observability, networking, system, docker, backup.
Control SeverityImpact level: critical, high, medium, low.
Control MappingLinks a control to an evidence source (e.g., healthcheck rule slug) with an operator and expected value. All mappings must pass for the control to pass.
EvaluationA per-control verdict computed by the compliance worker for a specific scope (host, environment, or client).
Evaluation StatusPossible verdicts: pass, fail, warning, unknown, not_applicable, excepted, pending_manual_review.
ScoreFramework compliance score computed as passed / (passed + failed), returned as a 0-1 ratio. Controls with unknown/excepted/pending status are excluded. Frontend displays as percentage.
Score ThresholdsPer-framework JSON config with good and warning values that determine the UI color. Above good = green, above warning = amber, below = red.
ScopeThe level at which evaluations, attestations, or exceptions apply: asset (single host), environment, or client.
AssetA minimal identity abstraction mapping a host, environment, or client to a UUID for compliance scoping and evidence linking.
RollupAggregated framework scores across all active hosts in an environment or client.
Manual AttestationA human-submitted verdict for a manual or hybrid control. Records the attester, timestamp, status (pass/fail/warning), optional note, and optional expiry. Overrides evidence-based evaluation.
ExceptionAn approved risk waiver that exempts a control from failing status. Has a reason, approver, and optional expiry. When active, marks the control as excepted and excludes it from the score.
Evidence SummaryJSON key-value data from healthcheck results attached to each evaluation, showing what was checked and the actual values found.
Re-evaluationRecalculation of compliance results. Triggered automatically after healthcheck runs, manually via API, or as a side-effect of attestation/exception changes.
Top Failed ControlsRanked list of controls failing across the most hosts in an environment or client scope.
Expiring ExceptionsExceptions approaching their expires_at date, surfaced in the client compliance tab.
Compliance WorkerA NATS consumer that evaluates all controls in all frameworks against healthcheck evidence and stores evaluations and scores.
Exception Expiry WorkerBackground job that periodically marks overdue exceptions as expired and triggers re-evaluation.

Change Detection

TermDefinition
Watched FileA file path on a host monitored for changes. Tracks SHA256 hash, size, mode, owner, and sensitivity flag.
File VersionA snapshot of a file's state at a point in time with version number, SHA256, content, unified diff against previous version, mode, owner, and size.
Change EventA recorded change with origin (agent file watcher, webhook), type (modified, created, deleted), severity, and timestamped summary.
Changes WorkerA NATS consumer that processes file change messages, handles batch reassembly, computes diffs, and stores file versions and change events.
Baseline ModeChange detection mode that computes and stores initial file hashes without triggering events.
Delta ModeChange detection mode that compares current file hashes against baseline and reports only changed files.
Webhook SourceA registered external source for webhook events (GitLab, GitHub, ArgoCD). Receives events via token-authenticated HTTP endpoints and normalizes them as change events.
RunbookExecutable operational procedure defined in YAML DSL with multi-step actions, dispatched to agents via NATS for automated remediation.

Authentication & Authorization

TermDefinition
UserA human account with email, password hash (optional), MFA status, and authentication provider (local or OAuth).
RoleA named permission set (system-defined or custom) with an array of permission strings (e.g., users:read, hosts:write).
PermissionAn access right in the system (e.g., hosts:read, compliance:write). Resolved from roles via RBAC.
SessionAn authenticated user's session with refresh token, device label, IP address, user agent, and revocation tracking.
Service AccountA machine-to-machine API credential with API key hash, expiry, client scope, and last-used timestamp.
TeamA group of users assigned to a set of clients, used for RBAC at the team level.
MFAMulti-Factor Authentication using TOTP. Mandatory for admin users.
Audit EntryA security event record (user action, system change) with actor, action, resource, timestamp, and IP/user agent.
Terminal SessionBrowser-based interactive shell access to a managed host, with RBAC enforcement, session recording, and audit logging.
Passkey / WebAuthnPasswordless authentication via FIDO2 credentials, allowing users to log in with biometrics or hardware security keys.

Configuration & Sync

TermDefinition
Host ConfigPer-host configuration (watch_files, healthcheck settings, collector config). One entry per config type per host.
Environment ConfigPer-environment configuration applied to all hosts in that environment. Merged with host-level configs.
Config SyncSystem allowing operators to push agent configuration changes from the backend API without redeploying agents.
Config VersionSequential version number for host configurations, used to track rollout progress.
Config Apply StatusLatest result of applying a config to a host (version, status: pending/applied/failed, error message).
Service LayerBackend architecture layer (backend/internal/service/) containing domain logic extracted from HTTP handlers. Services sit between handlers and stores, encapsulating business rules.

Messaging & Workers

TermDefinition
Agent Identity LayerThe agents table and enrollment flow that separate agent credentials from host data. An agent record is created at enrollment; a host record is created later when the first inventory message arrives. This separation supports collector agents (no host) and idempotent re-enrollment on pod restarts.
NATSMessage broker providing JetStream for persistent pub-sub and request-reply communication between agents and backend.
JetStreamNATS persistent message store with consumer groups and at-least-once delivery semantics.
SubjectNATS message routing key in hierarchical dot-separated format (e.g., proxima.client.env.host.inventory).
Durable ConsumerNamed JetStream consumer group that persists acknowledgments to resume from where it left off after restart.
UpsertInsert-or-update operation (INSERT ... ON CONFLICT DO UPDATE). Used for idempotent message processing.
HeartbeatPeriodic "still online" message from agent to backend. Used to determine host connectivity status.
Stale Host DetectorBackground worker that periodically marks hosts whose last_seen_at exceeds a threshold as offline.

Search & Frontend

TermDefinition
PQL (Proxima Query Language)A domain-specific query language for searching hosts by field/attribute. Compiled to SQL and executed against PostgreSQL.
Saved SearchA named, shareable PQL query saved per user with optional notification trigger.

AI & Automation

TermDefinition
AI ChatAI-assisted infrastructure investigation powered by Claude via the Model Context Protocol, with 20+ tools and a human-in-the-loop confirmation flow.
MCP ServerStandalone Model Context Protocol server exposing Proxima infrastructure tools to LLMs such as Claude Desktop, Cursor, and Claude Code.
Service DeskClient-facing ticket management module integrated with Jira ITSM, providing SLA tracking and a kanban board.