Metrics Reference¶

Pure catalog of all virtrigaud_* metric families. For operator interpretation, PromQL examples, alerting recipes, and wiring details see the Observability Guide.

All metrics are registered with controller-runtime's metrics registry and served on :8080/metrics alongside the standard workqueue_*, go_*, and process_* families.

Stable families (v0.3.8)¶

virtrigaud_build_info¶

Label notes:

• component: manager for the manager process; provider for provider sidecars that call SetupMetrics.
• go_version: the Go runtime version string returned by runtime.Version() (e.g. go1.26.0).

virtrigaud_manager_reconcile_total¶

outcome values: success, error, requeue.

kind values (as of v0.3.8): VirtualMachine, Provider, VMClass, VMImage, VMNetworkAttachment, VMAdoption, VMSnapshot, VMMigration, VMClone, VMSet, VMPlacementPolicy.

Note: VMClone and VMSet series are seeded to 0 at manager startup even before any resources of those kinds exist. The VMSet reconciler is a stub in v0.3.8; it emits outcome="error" for every reconcile until the controller is implemented.

virtrigaud_manager_reconcile_duration_seconds¶

virtrigaud_errors_total¶

component values: manager, provider.

reason is a small enum defined per-reconciler via errReason* constants. Taxonomy as of v0.3.8 for the VirtualMachine reconciler: get-vm, add-finalizer, remove-finalizer, deps-not-found, deps-error, provider-resolve, provider-validate, provider-describe, provider-task-status, provider-delete. The VMClone reconciler adds: get-clone, source-resolve, clone-target-exists, provider-clone. Other reconcilers define their own reason sets.

virtrigaud_provider_rpc_requests_total¶

provider_type: the value of Provider.spec.type (e.g. vsphere, libvirt, proxmox, mock).

method: short RPC name extracted from the gRPC full method path (e.g. Validate, Create, Delete, Power, Describe, Reconfigure, TaskStatus, ListVMs, SnapshotCreate, SnapshotDelete, SnapshotRevert, ExportDisk, ImportDisk, GetDiskInfo).

code: stringified gRPC status code from codes.Code.String(). Common values: OK, Unavailable, DeadlineExceeded, NotFound, InvalidArgument, Internal, Unknown. Circuit-breaker rejections appear as Unavailable.

virtrigaud_provider_rpc_latency_seconds¶

virtrigaud_circuit_breaker_state¶

provider: the metadata.name of the Provider CR. Seeded to 0 at manager startup when the gRPC client is constructed. One time-series per Provider CR.

virtrigaud_circuit_breaker_failures_total¶

Counts infra-class RPC failures (Unavailable, DeadlineExceeded, Internal, Unknown) that are counted toward the circuit breaker's failure threshold. Business-class errors (NotFound, InvalidArgument, etc.) do not increment this counter.

virtrigaud_vm_operations_total¶

operation values: Create, Delete, Power, Describe, Reconfigure.

outcome values: success, error.

provider: the metadata.name of the Provider CR (the providerName passed to NewClient).

One sample per VM operation method call (not per RPC — a Create that emits multiple TaskStatus polls still produces one sample here).

virtrigaud_ip_discovery_duration_seconds¶

Duration measured from vm.CreationTimestamp to the first reconcile where vm.Status.IPs transitions from empty to non-empty. Emits exactly one sample per VM over its lifetime (idempotent across manager restarts via etcd persistence).

virtrigaud_provider_tasks_inflight¶

Counts tasks the current manager instance is actively tracking (in its in-memory set). Seeded to 0 at manager startup. Measures "tasks THIS manager instance is tracking", not "tasks the provider believes are in-flight" — the gauge resets on manager restart.

Task-creating RPCs: Create, Delete, Power, Reconfigure, SnapshotCreate, SnapshotDelete, SnapshotRevert, ExportDisk, ImportDisk (9 methods). Tasks are removed from the set when IsTaskComplete or TaskStatus observes Done=true or a terminal error.

Deprecated families¶

virtrigaud_queue_depth¶

Superseded by controller-runtime's standard workqueue_depth{name} metric. The Go variable and SetQueueDepth helper remain for compile compatibility with out-of-tree code that imported the metrics package; production code no longer calls SetQueueDepth.

Migration: see the kind → controller-name mapping table in the Upgrade Guide.

Standard families (controller-runtime + Go runtime)¶

These appear on the same /metrics endpoint. Documented upstream; listed here for completeness.