Skip to main content
Version: 2.8

Portworx Backup metrics

Scraping endpoint : http://px-backup-svc-endpoint:<rest_port (default:10001)>/metrics.

NameDescriptionTypeLabelsValue
pxbackup_backup_statusStatus for backups in Portworx BackupGaugebackfill =
backup_namespace = comma separated backup namespaces cluster = name of cluster on which backup is taken
cluster_uid = alphanumeric cluster uid
error_reason=
name= name of the backup
namespaces = namespace where PXB is deployed
org_id= default
schedule_name = name of backup schedule
timestamp_in_secs =
user_id = user id for backup
Invalid = 0
Pending = 1
InProgress = 2
Aborted = 3
Failed = 4
Deleting = 5
Success = 6
Captured = 7
PartialSuccess = 8
DeletePending = 9
CloudBackupMissing = 10
pxbackup_backup_size_bytesSize in bytes of backups in Portworx BackupGaugecluster= name of cluster on which backup is taken
name= backup name
namespaces= comma separated backup namespaces
schedule_name= name of backup schedule associated with backup
user_id= userid for backup
Size of backup in bytes
pxbackup_backup_duration_secondsCompletion duration in seconds for backups in Portworx Backup backup schedulesGaugecluster= name of cluster on which backup is taken
name= backup name
namespaces= comma separated backup namespaces
schedule_name= name of backup schedule associated with backup
user_id= userid for backup
Duration of backup in seconds
pxbackup_backup_volume_countVolume count for backups in Portworx BackupGaugecluster= name of cluster on which backup is taken
name= backup name
namespaces= comma separated backup namespaces
schedule_name= name of backup schedule associated with backup
user_id= userid for backup
Number of volumes in backup
pxbackup_backup_resource_countResource count for backups in Portworx BackupGaugecluster= name of cluster on which backup is taken
name= backup name
namespaces= comma separated backup namespaces
schedule_name= name of backup schedule associated with backup
user_id= userid for backup
Number of resources in backup
pxbackup_backup_schedule_statusStatus of backup schedules in Portworx BackupGaugecluster= name of cluster on which backup is taken
name= backup name
namespaces= comma separated backup namespaces
user_id= userid for backup
Invalid = 0
Pending = 1
InProgress = 2
Aborted = 3
Failed = 4
Deleting = 5
Success = 6
Captured = 7
PartialSuccess = 8
DeletePending = 9
pxbackup_backup_location_statusStatus of backup locations in PXBGaugebackfill=
error_reason=reason for error
name= backup name
org_id = default
timestamp_in_secs =
user_id = user id for backup
Invalid = 0
Valid = 1
DeletePending = 2
ValidationInProgress = 3
ValidationFailed = 4
pxbackup_backup_countBackup counts in PXBGaugecluster= name of cluster on which backup is taken
user_id = user id for backup
org_id = default
cluster_uid = alphanumeric cluster uid
status=
Number of backups across all clusters
pxbackup_restore_countRestore counts in PX-BackupGaugecluster= name of cluster on which backup is taken
Number of restores across all clusters
pxbackup_backuplocation_metricsCount of backuplocations in Portworx BackupGaugename = name of backup location
user_id = userid for backup location
cluster_uid = alphanumeric cluster uid
org_id = default
Number of backup locations associated with PXB
pxbackup_cloudcred_metricsCount of cloud credentials configured in PXBGaugename = name of Cloud Cred
user_id = userid for cloudCred
Invalid = 0
AWS = 1
Azure = 2
Google = 3
IBM = 4
Rancher = 5
pxbackup_cluster_statusStatus of clusters in PXBGaugebackfill =
cluster_uid = alphanumeric cluster uid
error_reason = reason for failure
name = name of cluster

org_id= default
timestamp_in_secs=
user_id = user id for cluster
Invalid = 0
Online = 1
Offline = 2
DeletePending = 3
Pending = 4
Failed = 5
Success = 6
pxbackup_restore_statusStatus for restores in PXBGaugename = restore name
namespaces = comma separated restore namespaces
cluster = name of cluster on which restore is started
user_id = userid for restore
Invalid = 0
Pending = 1
InProgress = 2
Aborted = 3
Failed = 4
Deleting = 5
Success = 6
Retained = 7
PartialSuccess = 8
pxbackup_restore_size_bytesSize in bytes of restores in PXBGaugename = restore name
namespaces = comma separated restore namespaces
cluster = name of cluster on which restore is initiated
user_id = userid for restore
Size in bytes for restore
pxbackup_restore_duration_secondsCompletion duration in seconds for restore in PXBGaugename = restore name
namespaces = comma separated restore namespaces
cluster = name of cluster on which restore is initiated
user_id = userid for restore
Duration in seconds for restore
pxbackup_restore_volume_countVolume count for restores in PXBGaugename = restore name
namespaces = comma separated restore namespaces
cluster = name of cluster on which restore is initiated
user_id = userid for restore
Count of restored volumes
pxbackup_restore_resource_countResource count for restores in PXBGaugename = restore name
namespaces = comma separated restore namespaces
cluster = name of cluster on which restore is initiated
user_id = userid for restore
Count of restored application resources
pxbackup_schedpolicy_metricsCount of schedule policies in PXBGaugename = restore name
type = type of restore
user_id = userid for restore
Number of schedule policies associated with schedules
pxbackup_rule_metricsCount of backup rules in PXBGaugename = restore name
user_id = userid for restore
Number of backup rules associated with backups