NetBackup IT Analytics Exporter Installation and Configuration Guide

Last Published:
Product(s): NetBackup IT Analytics (11.4)

Configure the NetBackup exporter

To configure the NetBackup exporter, you must configure the netbackup.yaml file from the following location:

  • Linux: /opt/itanalytics/config/netbackup.yaml

  • Windows: C:\Program Files\Veritas\ITAnalytics\config\netbackup.yaml

Collectors within the exporter

The collectors embedded within the exporter are described in the table below. The scope of metrics collected by the NetBackup exporter is defined below. Other metrics are collected by the Node or Windows exporter.

Table: Collectors within the exporter

Collector

Collects

bp_configuration

NetBackup busy file processing details.

host_certificates

Metrics for expiring host certificate.

jks_certificates

Collector checks key-store file for expiring non-host certificates.

nbdb_file_stats

NetBackup database file details.

net_stats

Connection details for pbx_exchange, vnetd, bpcd, inbound_proxy, outbound_proxy, nbdisco, nbsl, nbsvcmon, nbrmms, vmd, nbatd, NB_dbsrv, bpdbm, bpjobd, bprd, nbpem, nbjm, nbstserv, nbemm, nbrb, nbevtmgr, nbaudit, nbwmc, bpcompatd, nbvault, and nbars processes.

pbx_exchange_stats

Details for connections made to pbx_exchange process.

physical_devives_stats

Information about the available block devices.

Collector is disabled for Windows host.

service_responsiveness

Status information of running processes, such as pbx_exchange, vnetd, bpcd, inbound_proxy, outbound_proxy, nbdisco, nbsl, nbsvcmon, nbrmms, vmd, nbatd, NB_dbsrv, bpdbm, bpjobd, bprd, nbpem, nbjm, nbstserv, nbemm, nbrb, nbevtmgr, nbaudit, nbwmc, bpcompatd, nbvault, and nbars.

The configuration parameters of the netbackup.yaml are described in the table below followed by a sample netbackup.yaml configuration file.

Table: Parameters of netbackup.yaml file

Parameter

Description

host

The host on which the the server runs. The default is localhost.

port

The port through which the exporter communicates: The default port is 9099.

install_path

If NetBackup is not installed at its default location, you need to specify its path here.

log_level

The default log level for the collectors. You can set it as error, warn, or debug. The default log level is info.

You can configure different values for different collectors.

collector_overrides

A map keyed by the name of the collector which you can override the poll_interval and log_level. To disable an individual collector, set enabled: false.

Collectors not mentioned in this map key are enabled by default. Exclude physical_device_stats collector if the exporter is configured to run on Windows.

key_stores

The list of key stores that you want the jks_certificates collector to check.

For jks_certificates of a collector, you can added multiple keystore files to collect data in the same manner. The exporter can process collector keystore files of type .jks and .bcfks without the configuration of this property. For keystore files of other types, you must specify store_type and provider_path values..

Each key store entry has the following properties:

 
name

The store label in the metrics.

key_file

The file that stores the keystore password.

store_file

Path to the keystore file.

alias

Alias name of the exported certificates.

store_type

Property that sets the -storetype switch while running the keytool command.

provider_path

Property that sets the -providerpath switch while running the keytool command.

provider

Property that sets the -provider switch while running the keytool command.

Example of netbackup.yaml file for Linux
host: localhost
port: 9099
install_path: /usr/openv
log_level: info
collector_overrides:
    bp_configuration:
        poll_interval: 10s
        log_level: info
        enabled: true
    host_certificates:
        poll_interval: 300s
        log_level: info
        enabled: true
    jks_certificates:
        poll_interval: 600s
        log_level: info
        enabled: true
    nbdb_file_stats:
        poll_interval: 86400s
        log_level: info
        enabled: true
    net_stats:
        poll_interval: 3600s
        log_level: info
        enabled: true
    pbx_exchange_stats:
        poll_interval: 300s
        log_level: info
        enabled: true
    physical_device_stats:
        poll_interval: 300s
        log_level: info
        enabled: true
    service_responsiveness:
        poll_interval: 10s
        log_level: info
        enabled: true
key_stores:
 - name: vxss
   key_file: /usr/openv/var/global/jkskey
   store_file: /usr/openv/var/global/vxss/tomcatcreds/nbwebservice.bcfks
   alias: nbwmc
   store_type: BCFKS
   provider_path: /usr/openv/java/bcprov-jdk15on-168.jar
   provider: org.bouncycastle.jce.provider.BouncyCastleProvider
 - name: wsl
   key_file: /usr/openv/var/global/jkskey
   store_file: /usr/openv/var/global/wsl/credentials/nbwebservice.bcfks
   alias: nbwmc
   store_type: BCFKS
   provider_path: /usr/openv/java/bcprov-jdk15on-168.jar
   provider: org.bouncycastle.jce.provider.BouncyCastleProvider

Note:

If netbackup.yaml file is missing or not configured correctly, the collectors collect metrics based on the default values.

Example of netbackup.yaml file for Windows
host: localhost
port: 9099
install_path: C:\Program Files\Veritas
log_level: info
collector_overrides:
    bp_configuration:
        poll_interval: 10s
        log_level: info
        enabled: true
    host_certificates:
        poll_interval: 300s
        log_level: info
        enabled: true
    jks_certificates:
        poll_interval: 600s
        log_level: info
        enabled: true
    nbdb_file_stats:
        poll_interval: 86400s
        log_level: info
        enabled: true
    net_stats:
        poll_interval: 3600s
        log_level: info
        enabled: true
    pbx_exchange_stats:
        poll_interval: 300s
        log_level: info
        enabled: true
    physical_device_stats:
        poll_interval: 300s
        log_level: info
        enabled: false
    service_responsiveness:
        poll_interval: 10s
        log_level: info
        enabled: true
key_stores:
 - name: vxss
   key_file: C:\Program Files\Veritas\NetBackup\var\global\jkskey
   store_file: C:\Program Files\Veritas\NetBackup\var\global\vxss\tomcatcreds\nbwebservice.bcfks
   alias: nbwmc
   store_type: BCFKS
   provider: org.bouncycastle.jce.provider.BouncyCastleProvider
   provider_path: C:\Program Files\Veritas\NetBackup\Java\bcprov-jdk15on-168.jar
 - name: wsl
   key_file: C:\Program Files\Veritas\NetBackup\var\global\jkskey
   store_file: C:\Program Files\Veritas\NetBackup\var\global\wsl\credentials\nbwebservice.bcfks
   alias: nbwmc
   store_type: BCFKS
   provider_path: C:\Program Files\Veritas\NetBackup\Java\bcprov-jdk15on-168.jar
   provider: org.bouncycastle.jce.provider.BouncyCastleProvider