Skip to main content
Version: 2.6

Portworx Backup metrics

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

NameDescriptionTypeLabelsValue
pxbackup_backup_statusStatus for backups in Portworx BackupGaugename=backup name
namespaces=comma separated backup namespaces
user_id=userid for backup
schedule_name= name of backup schedule associated with backup
Invalid = 0
Pending = 1
InProgress = 2
Aborted = 3
Failed = 4
Deleting = 5
Success = 6
Captured = 7
PartialSuccess = 8
DeletePending = 9
pxbackup_backup_size_bytesSize in bytes of backups in Portworx BackupGaugename=backup name
namespaces=comma separated backup namespaces
cluster=name of cluster on which backup is taken
user_id=userid for backup
schedule_name= name of backup schedule associated with backup
Size of backup in bytes
pxbackup_backup_duration_secondsCompletion duration in seconds for backups in Portworx Backup backup schedulesGaugename = backup name
namespaces = comma separated backup namespaces
cluster = name of cluster on which backup is taken
user_id =userid for backup
schedule_name = name of backup schedule associated with backup
pxbackup_backup_volume_countVolume count for backups in Portworx Backupname = backup name
namespaces = comma separated backup namespaces
cluster = name of cluster on which backup is taken
user_id = userid for backup
schedule_name = name of backup schedule associated with backup
pxbackup_backup_resource_countResource count for backups in Portworx BackupGaugename= backup name
namespaces = comma separated backup namespaces
cluster = name of cluster on which backup is taken
cluster = name of cluster on which backup is taken
schedule_name = name of backup schedule associated with backup
Number of resources in backup
pxbackup_backup_schedule_statusStatus of backup schedules in Portworx BackupGaugename = backup schedule
namespaces = comma separated backup schedule namespaces
cluster = name of cluster on which backup schedule is started
user_id = userid for backup schedule
Active = 0
Suspended/Deactive = 1
pxbackup_backuplocation_metricsCount of backuplocations in Portworx BackupGaugename = name of backup location
user_id = userid for backup location
1
pxbackup_cloudcred_metricsCount of cloudcredentials configured in PX-BackupGaugename = name of Cloud Cred
user_id = userid for cloudCred
Invalid = 0
AWS = 1
Azure = 2
Google = 3
pxbackup_cluster_statusStatus of clusters in Portworx BackupGaugename = name of cluster
user_id = userid for cluster
Invalid = 0
Online = 1
Offline = 2
DeletePending = 3
pxbackup_restore_statusStatus for restores in Portworx BackupGaugename = restore name
namespaces = comma separated restore namespaces
cluster = name of cluster on which restore is started
user_id = userid for restore
Pending = 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 Portworx BackupGaugename = 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 Portworx Backupname = 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 Portworx Backupname = 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 Portworx Backupname = 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 Portworx Backupname = restore name
user_id = userid for restore
1
pxbackup_rule_metricsCount of rule objects in Portworx Backupname = restore name
user_id = userid for restore
1
Was this page helpful?