Portworx Backup Metrics

Applicable to both Classic and Federated modes

Portworx Backup exposes Prometheus metrics via the /metrics endpoint that provide comprehensive monitoring data for backup, restore, clusters, backup locations, and other resources. Note that this is a point-in-time REST API endpoint that returns current metric values when queried — historical data and time-range queries require a Prometheus server to scrape and store these metrics over time. This guide helps you understand all available metrics, their labels, value ranges, and usage patterns.

Before accessing metrics, ensure you have set up Prometheus to scrape Portworx Backup metrics. See the following guides based on your environment:

• OpenShift metrics endpoint configuration
• Kubernetes metrics endpoint configuration

Scraping endpoint

Portworx Backup metrics can be scraped from the following endpoint:

http://px-backup-svc-endpoint:<rest_port>/metrics

Where <rest_port> is the REST API port (default: 10001).

or

http://<external-ip>:10001/metrics

where <external-ip> is the external IP address of the Portworx Backup service. 10001 is the default REST API port.

Metrics format

All metrics use the pxbackup_ prefix and follow Prometheus naming conventions. The endpoint returns metrics in Prometheus exposition (OpenMetrics) format.

Note: The Prometheus /metrics endpoint serves all available data in response and does not provide incremental delta or filtered data output.

Data provided by the /metrics endpoint without the pxbackup_ prefix can be ignored.

Backfill behavior

When the Portworx Backup pod restarts, it loads existing objects from the datastore and creates metrics with the backfill="true" label. This ensures metrics are available for existing backups, restores, and clusters even after pod restarts.

Metrics categories

Backup status and performance metrics

Metric retention summary

The table below shows how long each metric family's samples are kept, which Helm flag controls it, and the allowed bounds.

Metric family	Retention type	Helm flag	Bounds
pxbackup_backup_status, pxbackup_restore_status, pxbackup_cluster_status, pxbackup_backup_location_status	Dashboard alerting window (daily TTL sweep + startup backfill filter)	pxbackup.dashboardMetricsBackfillDays	30–90 days (default 90; values outside range are clamped)
pxbackup_backup_count, pxbackup_restore_count	Prometheus scrape retention	Prometheus --storage.tsdb.retention.time	Typically 90 days (server-level setting)
pxbackup_backup_object_info, pxbackup_virtual_machine_info, pxbackup_backup_volume_info, pxbackup_virtual_machine_resource_info, pxbackup_namespace_resource_info, pxbackup_namespace_resource_type_info	Info-metrics backfill window	pxbackup.backupInfoMetricsBackfillHours	0–720 hours (default 24 h; set to 0 to disable)

Configuring dashboard metric retention

The retention window for alerting dashboard metric samples (Failed backups, Failed restores, Failed clusters, ValidationFailed/LimitedAvailability backup locations) is configurable via the Helm value pxbackup.dashboardMetricsBackfillDays. Accepts an integer between 30 and 90 (inclusive); values outside this range are clamped (warning logged); unset or non-numeric values fall back to the default. The default is 90 days. The value is read once at pod startup; a helm upgrade with a new value triggers a rolling restart of the px-backup pod, after which the new window takes effect.

The same window applies to two behaviors:

• Daily TTL sweep: every 24 hours, px-backup deletes Prometheus samples for objects in an alerting status whose creation time is older than the window.
• Startup backfill filter: when the px-backup pod restarts, objects in an alerting status whose creation time is older than the window are not re-emitted as Prometheus samples.

caution

Setting pxbackup.dashboardMetricsBackfillDays to a value greater than 90 (for example, 365) does not give you a year of retention — values above 90 are silently clamped to 90 days. The effective maximum retention for dashboard alerting metrics is always 90 days, regardless of the value set.

This setting is also independent of pxbackup.backupInfoMetricsBackfillHours, which governs pxbackup_backup_object_info and related info metrics (different metric family, units in hours, default 24 h).

pxbackup_backup_status

Type: Gauge Lifecycle: Created when the backup is created, updated on status transitions, removed when the retention window expires (see Metric retention summary). Description: Current status of backups in Portworx Backup Usage: Monitor backup health, detect failures, track backup lifecycle

Label	Description	Type	Value Range	Example
name	Backup name	string	User-defined backup name	"mysql-backup-001"
namespaces	Kubernetes namespaces backed up	string	Comma-separated namespace list	"default,kube-system"
cluster	Source cluster name	string	Cluster identifier	"prod-cluster-1"
user_id	User who created the backup	string	User identifier/email	"admin@company.com"
schedule_name	Associated backup schedule	string	Schedule name or empty string	"daily-backup-schedule"
org_id	Organization ID	string	Organization identifier	"default"
cluster_uid	Unique cluster identifier	string	UUID format	"a1b2cXXX-XXXX-XXX-abcd-ef123456XXXX"
error_reason	Error details for failed backups	string	Error message or empty	"Volume snapshot failed: timeout"
timestamp_in_secs	Timestamp of last update	string	Unix timestamp as string	"1699123456"
backup_namespace	Actual namespaces in backup	string	Comma-separated namespace list	"app1,app2,monitoring"
backfill	Indicates backfilled metric	string	"true" or empty string	"true"

Status Values:

• 0: Invalid - Backup object is in invalid state
• 1: Pending - Backup is queued for execution
• 2: InProgress - Backup is currently running
• 3: Aborted - Backup was manually aborted
• 4: Failed - Backup failed with errors
• 5: Deleting - Backup is being deleted
• 6: Success - Backup completed successfully
• 7: Captured - Backup data captured (intermediate state)
• 8: PartialSuccess - Backup completed with some failures
• 9: DeletePending - Backup marked for deletion
• 10: CloudBackupMissing - Cloud backup data is missing

pxbackup_backup_count

Type: Counter Lifecycle: Created at first backup completion, incremented on each subsequent backup (see Metric retention summary). Description: Total number of backup operations (cumulative) Usage: Track backup frequency, generate rates

Label	Description	Type	Value Range
cluster_name	Source cluster name	string	Cluster identifier
user_id	Backup owner	string	User identifier
org_id	Organization ID	string	Organization identifier
cluster_uid	Cluster UUID	string	UUID format
status	Final backup status	string	Status enum as string

Status Values: "Success", "Failed", "PartialSuccess"

Backup schedule metrics

pxbackup_backup_schedule_status

Note: This metric is excluded in the OCP Prometheus
Type: Gauge
Lifecycle: Created when backup schedule is configured, updated when schedule is suspended/resumed, removed on schedule deletion
Description: Status of backup schedules (active/suspended)
Usage: Monitor schedule health, detect suspended schedules

Label	Description	Type	Value Range
name	Schedule name	string	User-defined schedule name
namespaces	Scheduled namespaces	string	Comma-separated namespace list
cluster	Target cluster	string	Cluster identifier
user_id	Schedule owner	string	User identifier

Values:

• 0: Active - Schedule is running normally
• 1: Suspended - Schedule is suspended/paused

Restore metrics

pxbackup_restore_status

Type: Gauge Lifecycle: Created when the restore is created, updated on status transitions, removed when the retention window expires (see Metric retention summary). Description: Current status of restore operations Usage: Monitor restore health, track restore progress

Label	Description	Type	Value Range	Example
name	Restore name	string	User-defined restore name	"mysql-restore-001"
namespaces	Target namespaces for restore	string	Comma-separated list	"prod-ns,app-ns"
cluster	Target cluster name	string	Cluster identifier	"staging-cluster"
user_id	Restore owner	string	User identifier	"admin@company.com"
cluster_uid	Target cluster UUID	string	UUID format	"b2c3d4e5-f6g7-8901-bcde-f23456789012"
error_reason	Error details for failed restores	string	Error message or empty	"PVC creation failed"
backup	Source backup name	string	Original backup name	"mysql-backup-001"
timestamp_in_secs	Last update timestamp	string	Unix timestamp	"1699123456"
org_id	Organization ID	string	Organization identifier	"default"
backfill	Backfilled metric indicator	string	"true" or empty	""

Status Values:

• 0: Invalid - Restore object is invalid
• 1: Pending - Restore is queued
• 2: InProgress - Restore is running
• 3: Aborted - Restore was aborted
• 4: Failed - Restore failed
• 5: Deleting - Restore is being deleted
• 6: Success - Restore completed successfully
• 7: Retained - Restore data retained
• 8: PartialSuccess - Restore completed with some failures

pxbackup_restore_count

Type: Counter Lifecycle: Created at first restore completion, incremented on each subsequent restore (see Metric retention summary). Description: Total number of restore operations (cumulative) Usage: Track restore frequency

Label	Description	Type	Value Range	Example
cluster	Target cluster name	string	Cluster identifier	"cluster-name"
cluster_uid	Target cluster UUID	string	UUID format	"670XXXXX-9b11-40a3-XXXX-eda95aXXXXXX"
org_id	Organization ID	string	Organization identifier	"default"
status	Final restore status	string	Status enum as string	"Failed"
user_id	Restore owner	string	User identifier/UUID	"70aXXXXX-419c-429f-XXXX-e302c2XXXXXX"

Status Values: "Success", "Failed", "PartialSuccess"

Cluster metrics

pxbackup_cluster_status

Type: Gauge Lifecycle: Created when the cluster is registered, updated on connectivity checks, removed when the retention window expires (see Metric retention summary). Description: Health status of registered clusters Usage: Monitor cluster connectivity, detect offline clusters

Label	Description	Type	Value Range	Example
name	Cluster name	string	User-defined cluster name	"production-k8s"
user_id	Cluster owner	string	User identifier	"admin@company.com"
org_id	Organization ID	string	Organization identifier	"default"
cluster_uid	Unique cluster identifier	string	UUID format	"c3d4e5f6-g7h8-9012-cdef-345678901234"
error_reason	Error details for failed clusters	string	Error message or empty	"Connection timeout"
timestamp_in_secs	Last status update time	string	Unix timestamp	"1699123456"
backfill	Backfilled metric indicator	string	"true" or empty	""

Status Values:

• 0: Invalid - Cluster configuration is invalid
• 1: Online - Cluster is healthy and accessible
• 2: Offline - Cluster is not reachable
• 3: DeletePending - Cluster is marked for deletion
• 4: Pending - Cluster registration is pending
• 5: Failed - Cluster registration/connection failed
• 6: Success - Cluster successfully registered but not online yet

Cluster discovery metrics

Applicable to Federated mode only

The following metrics track Gardener cluster discovery operations, connectivity, and token management in Federated mode.

pxbackup_cluster_discovery_config_status

Type: Gauge Lifecycle: Updated on every status transition during discovery runs and token refresh operations Description: Tracks the current status of each Cluster Discovery configuration. The gauge value encodes the status directly. Usage: Monitor cluster discovery health, detect failed configurations, and track token-related failures.

Label	Description
config_name	ClusterDiscoveryConfig name
org_id	Organization ID
user_id	Owner user ID of the ClusterDiscoveryConfig
project_name	Gardener project name
label_selector	Shoot label selector used for discovery
error_reason	Reason string (populated on failure)
error_type	Token failure category: token_expired, token_request_failure, token_validation_failure, or empty for non-token errors

Status Values:

• 1: InProgress — Discovery is currently running
• 2: Success — Discovery completed successfully
• 3: Failed — Discovery failed

note

The metric updater currently emits only status values 1 (InProgress), 2 (Success), and 3 (Failed). Status values 4 (Deleting) and 5 (DeletePending) are defined in the proto but are not emitted in this release.

error_type values:

Value	Description
token_expired	Gardener SA token expired before the refresh worker could renew it. The admin must update the credential.
token_request_failure	Token request failed (for example, ServiceAccount not found).
token_validation_failure	New token was created but failed validation against the Gardener API.
(empty)	Non-token error — discovery failure, connectivity issue, and so on.

pxbackup_last_discovery_stats

Type: Gauge Lifecycle: Updated at the end of each discovery run Description: Exposes the results of the most recent discovery run. Each stat is a separate time series distinguished by the stat label. The last_discovery_timestamp label provides the wall-clock time of the run. Usage: Track the outcome of each discovery cycle — how many clusters were discovered, deleted, or skipped.

Label	Description
config_name	ClusterDiscoveryConfig name
org_id	Organization ID
user_id	Owner user ID of the ClusterDiscoveryConfig
stat	One of: discovered, deleted, unmanaged, remanaged, skipped, failed
last_discovery_timestamp	RFC 3339 timestamp of the last discovery run

Value: Count for the given stat.

stat values:

• discovered: Newly discovered clusters (success + failure)
• deleted: Stale clusters removed or marked unmanaged

pxbackup_current_discovery_stats

Type: Gauge Lifecycle: Updated at the end of each discovery run Description: Tracks the total number of active and unmanaged clusters currently associated with the discovery configuration. Usage: Monitor the live count of clusters under a given discovery configuration.

Label	Description
config_name	ClusterDiscoveryConfig name
org_id	Organization ID
user_id	Owner user ID of the ClusterDiscoveryConfig
stat	One of: associated, unmanaged

Value: Count for the given stat.

pxbackup_gardener_connectivity_failure

Type: Gauge Lifecycle: Set to 1 on Gardener API failure; cleared on next successful contact Description: Indicates a communication failure with the Gardener API. The error_type label distinguishes network-level failures from authentication errors. At most one time series exists per configuration at any given time. Usage: Detect and alert on Gardener API connectivity or authentication issues.

Label	Description
config_name	ClusterDiscoveryConfig name
org_id	Organization ID
user_id	Owner user ID of the ClusterDiscoveryConfig
error_type	unreachable (network errors, DNS failures, timeouts) or auth_failure (HTTP 401/403)
error_reason	Full error message for diagnostic context

Value: 1 when a connectivity failure is detected; cleared to 0 on next successful contact.

pxbackup_gardener_shoot_kubeconfig_validation_failure

Type: Gauge Lifecycle: Set to 1 on validation failure; cleared to 0 on next successful validation Description: Indicates that a shoot cluster kubeconfig has failed validation (for example, malformed kubeconfig). Usage: Detect invalid or malformed shoot kubeconfigs that would prevent backup operations.

Label	Description
config_name	ClusterDiscoveryConfig name
org_id	Organization ID
user_id	Owner user ID of the ClusterDiscoveryConfig
cluster_name	Shoot cluster name

Value: 1 when kubeconfig validation fails; cleared to 0 on next successful validation.

Backup location metrics

pxbackup_backup_location_status

Type: Gauge Lifecycle: Created when the backup location is configured, updated on periodic validation checks, removed when the retention window expires (see Metric retention summary). Description: Status of backup locations in Portworx Backup Usage: Monitor backup destination health

Label	Description	Type	Value Range
name	Backup location name	string	User-defined location name
user_id	Location owner	string	User identifier
org_id	Organization ID	string	Organization identifier
error_reason	Error details	string	Error message or empty
timestamp_in_secs	Last validation time	string	Unix timestamp
backfill	Backfilled metric	string	"true" or empty

Status Values:

• 0: Invalid - Location configuration is invalid
• 1: Valid - Location is accessible and working
• 2: DeletePending - Location is being deleted
• 3: ValidationInProgress - Location is being validated
• 4: ValidationFailed - Location validation failed
• 5: LimitedAvailability - Location has limited functionality

pxbackup_backuplocation_metrics

Note: This metric is excluded in the OCP Prometheus
Type: Gauge Lifecycle: Created when backup location is configured/added, value remains constant at 1, removed on location deletion Description: Count of configured backup locations Usage: Track backup destination inventory

Labels: name, user_id, org_id Value: Always 1 (indicates location exists)

Cloud credential metrics

pxbackup_cloudcred_metrics

Note: This metric is excluded in the OCP Prometheus
Type: Gauge Lifecycle: Created when cloud credential is configured/added, value remains constant at 1, removed on credential deletion Description: Count and type of cloud credentials configured in Portworx Backup Usage: Track credential inventory

Parameter	Description	Type	Value Range
name	Credential name	string	User-defined name
user_id	Credential owner	string	User identifier

Cloud Credential Type Values:

• 0: Invalid - Invalid credential type
• 1: AWS - Amazon Web Services credentials
• 2: Azure - Microsoft Azure credentials
• 3: Google - Google Cloud Platform credentials
• 4: IBM - IBM Cloud credentials
• 5: Rancher - Rancher credentials

Policy metrics

pxbackup_schedpolicy_metrics

Note: This metric is excluded in the OCP Prometheus
Type: Gauge Lifecycle: Created when backup schedule policy is configured, removed on policy deletion Description: Count of schedule policies in Portworx Backup Usage: Track policy inventory

Labels: name, type, user_id Value: Always 1 (indicates policy exists)

pxbackup_volumeresourceonlypolicy_metrics

Type: Gauge Lifecycle: Created when volume resource only policy is configured, removed on policy deletion Description: Count of volume resource only policies Usage: Track specialized policy inventory

Labels: name, type, user_id Value: Always 1 (indicates policy exists)

pxbackup_rule_metrics

Type: Gauge Lifecycle: Created when rule is configured, removed on rule deletion Description: Count of backup rules in Portworx Backup Usage: Track rule inventory

Labels: name, user_id Value: Always 1 (indicates rule exists)

note

Backup information metrics, virtual machine metrics, backup volume metrics, and virtual machine resource metrics are supported starting from Portworx Backup version 2.10.1.

Backup information metrics

pxbackup_backup_object_info

Type: Gauge Lifecycle: Created at backup start, updated during execution, removed on backup object deletion or when the backfill window expires (see Metric retention summary). Description: Comprehensive backup information aggregating data from multiple backup-related metrics. Usage: Monitor complete backup details including scheduling, retention, resources, and virtual machines.

note

To enable these metrics for OpenShift Container Platform (OCP) Prometheus or external Prometheus servers, you must set the pxbackup.enableExternalMetricsScraping Helm parameter during installation or upgrade.

Label	Type	Description
name	string	Name of the backup object
uid	string	Unique identifier for the backup object
org_id	string	Organization UID that owns this backup
create_time_in_sec	int64	Creation time in seconds (Unix timestamp)
cluster	string	Name of the cluster if this backup is a synced backup
namespaces	string	Namespaces where the backup is taken
label_selectors	string	Label selectors to choose resources for backup
status	string	Current status of the backup operation [ Failed(4), Success(6), PartialSuccess(8), Deleting, DeletePending, Deleted]. Deleting and DeletePending indicate backups currently being torn down. Deleted is emitted once the backup is deleted; the original terminal status is preserved in previous_status.
status_reason		Status reason of the backup operation
backup_path	string	Path where backup is stored
backup_schedule_name	string	Name of the backup schedule, if the backup was taken by schedule
backup_schedule_uid	string	Unique identifier of the backup schedule, if the backup was taken by schedule
total_size	integer	Total size of the backup
resource_count	integer	Total count of resources in backup
backup_location_name	string	Name of the backup location
backup_location_uid	string	uid of the backup location
cloud_credential_name	string	Name of the cloud credential object attached
cloud_credential_uid	string	Unique identifier for the cloud credential rule object
backup_type	string	Type of backup. generic — KDMP-based backup used when CSI snapshots are unavailable or the ConfigMap is set to BACKUP_TYPE: "Generic"; normal — native CSI snapshot-based backup
retention_period	integer	Backup retention period
cluster_name	string	Reference to cluster object
cluster_uid	string	Unique identifier for the cluster object
ns_label_selectors	string	Label selectors for choosing namespaces
large_resource_enabled	bool	Indicates whether the backup uses the large-resource backup path. For details on what qualifies as large-resource and how to configure it, see Large-resource backup and restore
backup_object_type	string	[Values = All, VirtualMachine] Gives output of whether it is for all application or virtual machine specific backup
skip_vm_auto_exec_rules	bool	Skip auto execution rules for VirtualMachine backup
direct_kdmp	bool	Option to take backup as direct KDMP (cross-cloud backup)
retention_time	string	Expiration timestamp for locked backup retention
volumes_completion_time	string	This will store timestamp for the completion of volumes
resources_completion_time	string	This will store timestamp for the completion of resources
total_completion_time	string	This will store timestamp for the completion of entire backup
advanced_resource_label_selector	string	Advanced label selector supporting operators
schedule_policy_name	string	Name of the schedule policy object attached
schedule_policy_uid	string	Unique identifier of the schedule policy object attached
virtual_machines_total_count	int64	Total count of virtual machines
virtual_machines_failed_count	int64	Count of failed virtual machines
failed_resource_count	int64	Total failed resource count
failed_vol_count	int64	Total failed volume count
volume_count	integer	Total count of volumes in the backup (counterpart to failed_vol_count)
backup_id_list	string	Comma-separated list of per-volume backup IDs. Empty for Success / Failed / PartialSuccess backups (use pxbackup_backup_volume_info instead); populated for Deleting / DeletePending / Deleted backups.
previous_status	string	Original terminal status preserved when the backup transitions to Deleting / DeletePending / Deleted (for example, Success, Failed, PartialSuccess). Empty for terminal backups (Success/Failed/PartialSuccess).
previous_volume_count	integer	Volume count captured at deletion time, before backup.Volumes is cleared. Empty for terminal backups.
previous_total_size	integer	Total size captured at deletion time. Empty for terminal backups.
previous_backup_id_list	string	Per-volume backup IDs captured at deletion time. Empty for terminal backups.
volume_resource_only_policy_name	string	Name of the volume resource only policy attached
volume_resource_only_policy_uid	string	Unique Identifier of the volume resource only policy attached

Virtual machine metrics

pxbackup_virtual_machine_info

Type: Gauge Lifecycle: Created when virtual machine backup starts, updated during backup execution, removed on backup object deletion or when the backfill window expires (see Metric retention summary). Description: Information about virtual machines included in backups. Usage: Track virtual machine backup status and details.

note

To enable these metrics for OpenShift Container Platform (OCP) Prometheus or external Prometheus servers, you must set the pxbackup.enableExternalMetricsScraping Helm parameter during installation or upgrade.

Label	Type	Description
backup_name	string	Name of the backup in which this volume is part of
backup_id	string	Unique Reference to the backup Object
schedule_policy_name	string	Name of the schedule policy object attached
schedule_policy_uid	string	Unique identifier of the schedule policy object attached
cluster_name	string	Reference to cluster object
cluster_uid	string	Unique identifier for the cluster object
name	string	Name of the virtual machine
namespace	string	Namespace of the virtual machine
os_name	string	Operating system name
status	string	Status of the virtual machine backup
status_reason	string	Status reason of the virtual machine backup
create_time_in_sec	int64	Creation time in seconds (Unix timestamp)

Backup volume metrics

pxbackup_backup_volume_info

Type: Gauge Lifecycle: Created when volume backup starts, updated during backup execution, removed on backup object deletion or when the backfill window expires (see Metric retention summary). Description: Detailed information about volumes included in backups. Usage: Track volume backup status, sizes, and storage details.

note

To enable these metrics for OpenShift Container Platform (OCP) Prometheus or external Prometheus servers, you must set the pxbackup.enableExternalMetricsScraping Helm parameter during installation or upgrade.

Label	Type	Description
backup_name	string	Name of the backup in which this volume is part of
backup_id	string	Unique Reference to the backup Object
name	string	Name of the volume
namespace	string	Namespace of the volume
pvc	string	Persistent Volume Claim name
status	string	Status Value of the metric [ Failed(4), Success(6), PartialSuccess(8)]
driver_name	string	Storage driver name
total_size	integer	Total size of the volume
actual_size	integer	Actual backup size (incremental size for incremental backups)
storage_class	string	Storage class of the volume
pvc_id	string	Unique identifier for the PVC
provisioner	string	Storage provisioner
volume_snapshot	string	Volume snapshot reference
virtual_machine_name	string	Associated virtual machine name
backup_mode	enum (string)	Backup mode: Not Supported (1), Full (2), Incremental (3)

Virtual machine resource metrics

pxbackup_virtual_machine_resource_info

Type: Gauge Lifecycle: Created when virtual machine resource backup starts, updated during backup execution, removed on backup object deletion or when the backfill window expires (see Metric retention summary). Description: Information about Kubernetes resources associated with virtual machines Usage: Track resource backup details for virtual machine workloads

note

To enable these metrics for OpenShift Container Platform (OCP) Prometheus or external Prometheus servers, you must set the pxbackup.enableExternalMetricsScraping Helm parameter during installation or upgrade.

Label	Type	Description
virtual_machine_name	string	virtual machine name associated with this resource
name	string	Name of the resource
namespace	string	Namespace of the resource
group	string	Group of the resource
kind	string	kind of the resource
version	string	version of the resource
backup_name	string	Name of the backup in which this volume is part of
backup_id	string	Unique Reference to the backup Object

Namespace resource metrics

pxbackup_namespace_resource_info

Type: Gauge
Lifecycle: Created at backup completion, updated during metric refresh, removed on backup object deletion or when the backfill window expires (see Metric retention summary).
Description: Namespace-level backup status and resource metrics for non-VM backups.
Usage: Monitor per-namespace backup health, track resource and volume counts, identify failed namespaces within a backup.

note

To enable these metrics for OpenShift Container Platform (OCP) Prometheus or external Prometheus servers, you must set the pxbackup.enableExternalMetricsScraping Helm parameter during installation or upgrade.

Label	Type	Description
backup_id	string	Unique identifier (UID) of the backup object
name	string	Name of the namespace
backup_name	string	Name of the backup object
status	string	Status of the namespace backup (e.g., Success, Failed, PartialSuccess)
status_reason	string	Reason for the current status, provides details on failures
total_resources	int32	Total number of resources in this namespace
total_volumes	int32	Total number of volumes in this namespace
total_failed_resources	int32	Number of resources that failed to backup in this namespace
total_failed_volumes	int32	Number of volumes that failed to backup in this namespace
create_time_in_sec	int64	Creation time in seconds (Unix timestamp)

pxbackup_namespace_resource_type_info

Type: Gauge
Lifecycle: Created at backup completion, updated during metric refresh, removed on backup object deletion or when the backfill window expires (see Metric retention summary).
Description: Resource type breakdown within each namespace for non-VM backups.
Usage: Monitor specific resource types (e.g., Deployments, ConfigMaps, Secrets) within a namespace, identify which resource types have failures.

note

To enable these metrics for OpenShift Container Platform (OCP) Prometheus or external Prometheus servers, you must set the pxbackup.enableExternalMetricsScraping Helm parameter during installation or upgrade.

Label	Type	Description
backup_id	string	Unique identifier (UID) of the backup object
namespace	string	Name of the namespace containing this resource type
name	string	Name of the resource type (e.g., "core/v1/Secret", "apps/v1/Deployment")
backup_name	string	Name of the backup object
total_resources	int32	Total number of resources of this type
total_failed_resources	int32	Number of resources of this type that failed to backup

Unsupported metrics

The following metrics are not fully supported yet. Exclude them in a production environment.

1. pxbackup_backup_size_bytes
2. pxbackup_backup_duration_seconds
3. pxbackup_backup_volume_count
4. pxbackup_backup_resource_count
5. pxbackup_restore_size_bytes
6. pxbackup_restore_duration_seconds
7. pxbackup_restore_volume_count
8. pxbackup_restore_resource_count