nbsmartdiag — NetBackup 10.1.1 | Cohesity Documentation

Name

nbsmartdiag — detects performance issues for registered NetBackup processes and collects appropriate troubleshooting information.

SYNOPSIS

nbsmartdiag -install

nbsmartdiag -uninstall

nbsmartdiag -start

nbsmartdiag -terminate

nbsmartdiag -version

nbsmartdiag -help

nbsmartdiag -list_config

On UNIX systems, the directory path to this command is /usr/openv/netbackup/bin/

On Windows systems, the directory path to this command is install_path\NetBackup\bin\

DESCRIPTION

The nbsmartdiag utility detects performance issues such as CPU utilization, memory usage, and deadlocks for the registered NetBackup processes. When nbsmartdiag detects these issues, it begins to collect the appropriate evidence for further troubleshooting without any user intervention.

This utility is designed to collect evidence to assist with troubleshooting. Veritas recommends that you stop the utility once the evidence is collected.

The nbsmartdiag utility runs as Local System or root.

The behavior of the utility is defined by modifying bp.conf or registry values. The bp.conf file values are set on the master server with the bpsetconfig command or the nbsetconfg command on client.

After the configuration is complete, start the service with the nbsmartdiag -start command. On Windows you can also start the utility from Service Control Manager.

The evidence is gathered in the nbsmartdiag folder at the location that is specified in the NBSD_EVIDENCE_PATH value. For each instance of the process, there is a subfolder inside the process name folder. Under that process ID folder, the evidence is collected for each occurrence of an event.

Java processes have a common run-time name. To monitor the NetBackup Administrative Console use adminconsole. For NetBackup Web Management Service use nbwmc in the process names.

Table: bp.conf values and Windows registry key names

Value	Details
NBSD_POLL_INTERVAL	Description Interval in seconds after which the service checks the process. Registry key type DWORD Default value 600
NBSD_DUMP_COUNT	Description Number of dumps to take once threshold is detected. Registry key type DWORD Default value 3 Valid range for this value is 0 to 10. Any invalid input results in this value being reset to the default.
NBSD_MONITOR_CPU	Description Process to be monitored for CPU usage threshold in percentage. Format is **ProcessName:cpu_in_percent. Do not specify the percent sign. Registry key type REG_SZ** Default value PROC_NAME1:CPU_percent, PROC_NAME2:CPU_percent, PROC_NAME3:CPU_percent
NBSD_MONITOR_MEMORY	Description Process to be monitored for Memory usage threshold. Format is ProceessName:MemSize. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value PROC_NAME1:MEM_SIZE1, PROC_NAME2:MEM_SIZE2, PROC_NAME3:MEM_SIZE3
NBSD_MEMORY_UNIT	Description This value determines the units the utility uses for memory calculations. If the unit is PERCENT then the memory threshold calculations are done as the percent of memory the process uses out of the total system memory. If the unit is ABSOLUTE then the absolute value in megabytes is used for threshold calculations. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value ABSOLUTE
NBSD_MONITOR_DEADLOCK	Description Process to be monitored for Deadlock. If CPU and Memory usage are constant for a long interval, Veritas assumes that it is a deadlock. The default value is 60 minutes. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value PROC_NAME1, PROC_NAME2, PROC_NAME3
NBSD_DEADLOCK_INTERVAL	Description The interval, in minutes, after which the process is considered inactive. Registry key type DWORD Default value 60
NBSD_ALWAYS_DUMP	Description Capture the process dump without taking into account the average of last 5 readings. When this parameter is set to 1, the utility captures the process dump every time the threshold is reached. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_CAPTURE_PROCESS_DUMP	Description Set this value to 1 to capture the Process Dump when the threshold is reached. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_INCREASE_LOG_LEVEL	Description Increase the logging for the process automatically. Changes to this value result in changes in the `nblog.conf` file. This value is for the VxUL processes. This value does not change the log level for legacy processes as it leads to large log files. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_CAPTURE_NETWORK_STAT	Description Set the value as 1 to monitor network connections at the time of event. Registry key type DWORD Default value 1 Valid values are either 0 or 1.
NBSD_CAPTURE_DISK_IO	Description Set this value to 1 to capture system disk IO stats at the point of event. Registry key type DWORD Default value 1 Valid values are either 0 or 1.
NBSD_NUMBER_OF_READINGS	Description This setting defines the number of readings to capture in case of the threshold event. Registry key type DWORD Default value 50
NBSD_READING_INTERVAL	Description Specifies the interval when the reading should be taken. Registry key type DWORD Default value 5
NBSD_PURGE_OLD_EVIDENCE	Description Purges the old evidence logs present in the directory that is given in the NBSD_EVIDENCE_PATH value. Be sure to make copies of the evidence otherwise the information is lost. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_CAPTURE_WITHOUT_THRESHOLD	Description When this option is set, nbsmartdiag captures the evidence even if the threshold had not reached for the registered process. This flag overrides all the threshold values. Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_JDK_HOME	Description Path to JDK Home folder. This option is required to execute JSTACK on Java processes. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value None
NBSD_EVIDENCE_PATH	Description Path to evidence collection folder. This value is a required value. Ensure that the folder has sufficient space to gather logs. Do not enclose the value in quotation marks. Registry key type REG_SZ Default value None. This value is mandatory for the service to launch.
NBSD_VERBOSE	Description Enable verbose logs for the NetBackup Performance Smart Diagnosis (NBSD). Registry key type DWORD Default value 0 Valid values are either 0 or 1.
NBSD_AUTO_MONITOR	Description Enables monitoring of all the NetBackup processes on the NetBackup host with default CPU and Memory threshold values. The default CPU threshold is 90 percent and default memory threshold are 60%. To change default threshold values refer to the NBSD_AUTOMONITOR_CPU_THRESHOLD and NBSD_AUTOMONITOR_MEMORY_THRESHOLD configuration parameters. NBSD_CAPTURE_WITHOUT_THRESHOLD parameter is ignored when NBSD_AUTO_MONITOR is set to 1. Registry key type REG_DWORD Default value 0
NBSD_AUTOMONITOR_CPU_THRESHOLD	Description Enables monitoring of all the NetBackup processes in the NetBackup host with default CPU and Memory threshold values. The value is in percentage and can have values in between 1 and 100. Registry key type REG_DWORD Default value 90
NBSD_AUTOMONITOR_MEMORY_THRESHOLD	Description Defines the memory threshold value that is used for monitoring all the NetBackup processes. The value denotes the memory usage percentage of the total memory process. This value is considered for threshold decision making. The value is in percentage and can have values between 1 and 100. Registry key type REG_DWORD Default value 60
NBSD_MONITOR_POLICY_NAME	Description Policies to monitor the CPU, memory, and deadlock thresholds. The process that is launched after the policy execution is automatically added for monitoring with default threshold values. This parameter is only applicable for primary server. The value for this parameter is a comma-separated list of polices to monitor. Do not enclose the value in quotation marks. NBSD_MONITOR_POLICY_NAME=Policy1, Policy2, Policy3 The default CPU threshold is 90 percent and default memory threshold are 60%. To change default threshold values refer to the NBSD_AUTOMONITOR_CPU_THRESHOLD and NBSD_AUTOMONITOR_MEMORY_THRESHOLD configuration parameters. Only the clients that are listed in the policy are considered for monitoring. The only processes that are monitored are the ones that are started on those clients after the policy starts. Clients that are discovered when the policy runs are not considered for monitoring. The NBSD_CAPTURE_WITHOUT_THRESHOLD parameter is ignored when NBSD_MONITOR_POLICY_NAME is set. Registry key type REG_SZ Default value No default value
NBSD_MONITOR_SYSTEM_FOR_HOURS	Description Defines the time in hours after which the nbsmartdiag process automatically stops. By default, the service runs for 7 days (168 hrs) and then stops itself. The value 0 means that the process runs forever. Registry key type REG_DWORD Default value 168
NBSD_EVIDENCE_SIZE_LIMIT	Description Defines the size limit in GB in the evidence folder. The value of 0 means no limitation on size. If the size before the evidence that is captured is less than the set size, the evidence is captured and not stopped in between even if the size exceeds. The next evidence is not captured. Registry key type REG_DWORD Default value 0
NBSD_PUSH_MONITOR_DATA_TO_REMOTE	Description Allows nbsmartdiag to push the list of identified processes with the default threshold values during the policy execution to the respective clients or media servers. This option is effective when a user specifies the policy name in the NBSD_MONITOR_POLICY_NAME value. This option is disabled by default. Registry key type REG_DWORD Default value 0

REQUIREMENTS

This utility only works for Windows, RHEL, and SUSE operating systems.

For Linux, the commands that are shown must be present on the computer to gather all supporting evidence: gcore, gstack, iostat, mpstat, netstat, pmap, top, and vmstat

For Windows, you must install the utility on Windows Server 2012 R2 or later. The utility uses process snapshot APIs which were introduced in Windows Server 2012 R2. Attempts to install the utility on older versions of Windows result in failure.

You must manually start the nbsmartdiag service. The bpup, bp.start_all, and netbackup start, commands do not start the service. This behavior is by design.

Note:

Cyrillic characters in the evidence path are not supported.

OPTIONS

-help: Displays the help output for the nbsmartdiag utility.
-install: Installs the nbsmartdiag utility.
-list_config: Displays the configuration details with the default and current value of nbsmartdiag utility.
-start: Starts the nbsmartdiag utility.
-terminate: Stops the nbsmartdiag utility.
-uninstall: Uninstalls the nbsmartdiag utility.
-version: Displays the version information for the nbsmartdiag utility.