Search <book_title>...

NetBackup IT Analytics Exporter Installation and Configuration Guide

Last Published: 2024-09-04

Product(s): NetBackup IT Analytics (11.3)

Configure Data Sender

Data Sender acts as a Prometheus server for all exporters, be it NetBackup IT Analytics Exporter or other third-party exporters. It pulls scraped data from exporters configured with it and pushes it to the Data Collector. Depending on the probe selection during the exporter installation, the default Data Sender will get configured for the applicable exporters. For Compute Resources probe, Data Sender for Node and Process exporter data is enabled for Linux OS and Data Sender for Windows exporter is enabled for Windows OS.

For NetBackup Resources Monitor probe, Data Sender for NetBackup IT Analytics Exporter will be enabled.

To configure the Data Sender, you must configure the datasender.yaml file from the following location:

On Linux: /opt/itanalytics/config/datasender.yaml
On Windows: C:\Program Files\Veritas\ITAnalytics\config\datasender.yaml

Since the probe selection during the NetBackup IT Analytics Exporter installation governs the Data Sender configuration, it does not require a separate configuration. However, to make changes to the poll interval or to the metrics collection, you must edit the datasender.yaml configuration file based on the property description below.

Table: datasender.yaml properties

Property	Description
host_name	System host name on which Data Sender will run. Default value will be system host name.
destination_url	URL of the NetBackup IT Analytics Data Collector where the scraped data will be pushed.
destination_certificate_file	Absolute path of the Data Sender's certificate file. The certificate file must be downloaded from the appropriate Data Collector policy screen based on the probe selection.
data_directory	Relative path of the directory for saving the collected data files. Default value is `/data`.
log_level	Logging level for Data Sender logs - trace, info, debug, warn, or error. Default will be `info`.
gzip	Flag for gzip post request content. Default value is set to `true`.
exporters	List of exporters with their scraping details:
<EXPORTER_NAME>	Exporter name.
source_url	URL on which the exporter is exposing its metrics.
job_id	The Sender ID provided during the NetBackup IT Analytics Exporter installation.
job_type	Set the value as `host` for all exporters.
jobs	List of jobs running independently and collecting metrics.
	job_name: Name of the specified scraped data job. poll_interval: Interval in seconds between two consecutive data collection jobs. gzip: Flag for gzip post request content. target_metrics: Defines the metrics to be sent to the Data Collector.

Sample Data Sender Configuration for Linux

# host_name: "nb1.example.com"
destination_url: "https://DC_HOSTNAME:8883/metrics"
destination_certificate_file: "/opt/itanalaytics/config/DC_CERT_FILE"
# data_directory: "data/"
# log_level: "info"
# gzip: true

exporters:
 netbackup:
  source_url: "http://127.0.0.1:9099/metrics"
  job_id: "job_id_1"
  job_type: "host"
  jobs:
  - job_name: "nb_host_certificate"
  poll_interval: 86400  # daily
  gzip: true
  target_metrics: [ "netbackup_host_certificate_active", 
                    "netbackup_host_certificate_issued_on_seconds", 
                    "netbackup_host_certificate_updated_on_seconds",
                    "netbackup_host_certificate_valid_from_seconds", 
                    "netbackup_host_certificate_valid_until_seconds" ]

  - job_name: "nb_keystore"
  poll_interval: 86400  # daily
  target_metrics: [ "netbackup_keystore_created_on_seconds", 
                    "netbackup_keystore_valid_from_seconds", 
                    "netbackup_keystore_valid_to_seconds" ]

  - job_name: "nb_responsiveness"
  poll_interval: 300   # 5 minutes
  target_metrics: [ "netbackup_process_running", 
                    "netbackup_process_responsive_seconds" ]

  - job_name: "nb_configuration"
  poll_interval: 86400  # daily
  target_metrics: [ "netbackup_bp_config_state", 
                    "netbackup_process_primary_server", 
                    "netbackup_process_media_server" ]

  - job_name: "nb_netstat"
  poll_interval: 3600  # 1 hour
  target_metrics: [ "netbackup_connection_active" ]

  - job_name: "nb_dbfile"
  poll_interval: 3600  # 1 hour
  target_metrics: [ "netbackup_dbfile_bytes", 
                          "netbackup_dbfile_mod_time_seconds" ]

  - job_name: "nb_pbxexchange"
  poll_interval: 300  # 5 minutes
  target_metrics: [ "netbackup_pbx_exchange_number_of_connections" ]

  - job_name: "nb_scrapeinfo"
  poll_interval: 1800  # 30 minutes
  target_metrics: [ "netbackup_scrape_success", 
                    "netbackup_scrape_duration_seconds" ]

   - job_name: "nb_buildinfo"
   poll_interval: 86400  # daily
   target_metrics: [ "netbackup_exporter_build_info" ]

  node:
    source_url: "http://127.0.0.1:9100/metrics"
    job_id: "job_id_10"
    job_type: "host"
    jobs:
      - job_name: "node_all"
        poll_interval: 300  # 5 minutes

  process:
    source_url: "http://127.0.0.1:9256/metrics"
    job_id: "job_id_20"
    job_type: "host"
    jobs:
      - job_name: "process_all"
        poll_interval: 900  # 15 minutes

Sample Data Sender Configuration for Windows

# host_name: "nb1.example.com"
destination_url: "https://DC_HOSTNAME:8883/metrics"
destination_certificate_file: "C:\\Program Files\\Veritas\\IT 
Analytics\\config\\DC_CERT_FILE"
# data_directory: "data/"
# log_level: "info"
# gzip: true

exporters:
  netbackup:
  source_url: "http://127.0.0.1:9099/metrics"
  job_id: "job_id_1"
  job_type: "host"
  jobs:
  - job_name: "nb_host_certificate"
  poll_interval: 86400  # daily
  gzip: true
  target_metrics: [ "netbackup_host_certificate_active", 
                    "netbackup_host_certificate_issued_on_seconds", 
                    "netbackup_host_certificate_updated_on_seconds",
                    "netbackup_host_certificate_valid_from_seconds", 
                    "netbackup_host_certificate_valid_until_seconds" ]

  - job_name: "nb_keystore"
  poll_interval: 86400  # daily
  target_metrics: [ "netbackup_keystore_created_on_seconds", 
                    "netbackup_keystore_valid_from_seconds", 
                    "netbackup_keystore_valid_to_seconds" ]

   - job_name: "nb_responsiveness"
   poll_interval: 300   # 5 minutes
   target_metrics: [ "netbackup_process_running", 
                     "netbackup_process_responsive_seconds" ]

    - job_name: "nb_configuration"
    poll_interval: 86400  # daily
    target_metrics: [ "netbackup_bp_config_state", 
                      "netbackup_process_primary_server", 
                      "netbackup_process_media_server" ]

     - job_name: "nb_netstat"
     poll_interval: 3600  # 1 hour
     target_metrics: [ "netbackup_connection_active" ]

     - job_name: "nb_dbfile"
     poll_interval: 3600  # 1 hour
     target_metrics: [ "netbackup_dbfile_bytes", 
                       "netbackup_dbfile_mod_time_seconds" ]

     - job_name: "nb_pbxexchange"
     poll_interval: 300  # 5 minutes
     target_metrics: [ "netbackup_pbx_exchange_number_of_connections" ]

     - job_name: "nb_scrapeinfo"
     poll_interval: 1800  # 30 minutes
     target_metrics: [ "netbackup_scrape_success", 
                       "netbackup_scrape_duration_seconds" ]

     - job_name: "nb_buildinfo"
     poll_interval: 86400  # daily
     target_metrics: [ "netbackup_exporter_build_info" ]

  windows:
    source_url: "http://127.0.0.1:9182/metrics"
    job_id: "job_id_30"
    job_type: "host"
    jobs:
      - job_name: "windows_exporter_all"
        poll_interval: 300  # 5 minutes