Version 3.8.0

3.7.3 Scrape the nxs-backup metrics

Prometheus config

To scrape metrics of nxs-backup by Prometheus configure the target. See the config reference here.

  - job_name: 'nxs-backup'
    metrics_path: /metrics
    static_configs:
      targets: ['10.6.8.184:7979'] # Configure the monitored nxs-backup host address

For Prometheus running in Kubernete/OpenShift with operator you can add a ServiceMonitor.

Example of SM for nxs-backup deployed by nxs-universal-chart:

serviceMonitors:
  nxs-backup:
    endpoints:
    - interval: 5m
      port: http
      path: /metrics
    extraSelectorLabels:
      app: nxs-backup-metrics

Metrics details

Here is a list of exported metrics and their labels.

nxs_backup_update_available

Indicates if a more recent version of nxs-backup is available.

Labels:

project	The project name for which backups collected
server	The server name on which backups collected

nxs_backup_collection_success

Indicates if the backup collection succeeded

Labels:

project	The project name for which backups collected
server	The server name on which backups collected
job_name	The backup job name
job_type	The type of the backup job
source	The source name for which backup collected
target	The path of the source for which backup collected e.g. database or element of glob

nxs_backup_collection_time

Shows the time, in seconds, in which the backup was collected.

Labels:

project	The project name for which backups collected
server	The server name on which backups collected
job_name	The backup job name
job_type	The type of the backup job
source	The source name for which backup collected
target	The path of the source for which backup collected e.g. database or element of glob

nxs_backup_delivery_success

Indicates whether the backup was successfully delivered.

Labels:

project	The project name for which backups collected
server	The server name on which backups collected
job_name	The backup job name
job_type	The type of the backup job
source	The source name for which backup collected
target	The path of the source for which backup collected e.g. database or element of glob

nxs_backup_delivery_time

Shows the time, in seconds, in which the backup was delivered.

Labels:

project	The project name for which backups collected
server	The server name on which backups collected
job_name	The backup job name
job_type	The type of the backup job
source	The source name for which backup collected
target	The path of the source for which backup collected e.g. database or element of glob