disco_profiling_data.pl

Use the disco_profiling_data.pl script to output summary data of all the discoveries run on a domain or extracted from a given profiling cache. This script includes data on how long it took to transfer discovery profiling data to the NCIM topology database. Data is sorted by discovery time.

Description

The script is run using the following command line. Optional arguments are shown enclosed in square brackets.
$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/disco_profiling_data.pl -domain domain_name  [ -fromcache ] [ -discocachefile discovery_cache_filename ] [ -modelcachefile model_cache_filename ]  [ -last ] [ -agents ] [ -debug debug_level ] [ -help ]
The script reads data from the Topology manager database table, model.profilingData.
Note: The Discovery engine, ncp_disco, must be running in order for this script to work.

Running the script

To retrieve data from a specified domain, use a command line similar to the following:
$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/disco_profiling_data.pl -domain NCOMS
To retrieve data from cache files, use a command line similar to the following:
$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/disco_profiling_data.pl -domain NCOMS -fromcache
To retrieve data from discovery and model caches, use a command line similar to the following:
$NCHOME/precision/bin/ncp_perl $NCHOME/precision/scripts/perl/scripts/disco_profiling_data.pl -domain NCOMS -discocachefile Disco.Cache.disco.profilingData.NCOMS -modelcachefile Model.Cache.model.profilingData.NCOMS

Command-line options

The following table describes the command-line options for the script.

Table 1. disco_profiling_data.pl command-line options
Command-line option Description
-agents

Returns profiling data on running discovery agents. Displays the following information:

  • Agent Name: The name of the agent.
  • Despatch: How many entities have been sent to the agent.
  • Interface Records: How many interface (component) records were in the responses.
  • Remote Neighbours: How many remote connection references were in the responses.
-debug debug_level Optional; specifies required debug level.
-discocachefile discovery_cache_filename Optional; name of a discovery cache file to extract disco profiling data from. This setting overrides the -fromcache setting.
-domain DomainName Mandatory; the name of the domain to retrieve data from.
-fromcache Optional; instructs the script to retrieve data from the cache files. In this case the Discovery engine, ncp_disco, and the Topology manager, ncp_model, do not need to be running.
-help Optional; provides help on this command
-last Optional. This integer specifies the last n discoveries for which to display statistics.
-latest Optional: only the last discovery or ncp_model process data is displayed.
-modelcachefile model_cache_filename Optional; name of a model cache file to extract model profiling data from. This setting overrides -fromcache setting.
-stitchers

Optional: displays a breakdown of how long each stitcher took to process the topology. Displays the following information:

  • StitcherName: The name of the stitcher.
  • Total: The total time in milliseconds that the stitcher took during the profiling interval, that is, from the start of phase 1 to the end of phase.
  • Executions: The number of times that the stitcher was run.
  • Average: The average time that the stitcher took, in milliseconds.
  • Total: The total percentage of the discovery processing time that the stitcher took.
-verbose Optional; provides more information on the screen.

Output

Running the script retrieves output similar to the following:

-----------------------------------------------------------------------------------
Domain        Date_of_discovery     collection  processing   transfer     total    
-----------------------------------------------------------------------------------

NCOMS        2012-08-24T23:00:00    00:33:26    00:18:02    00:00:00    00:00:00   
NCOMS        2012-09-30T23:00:04    00:30:36    00:16:04    00:11:04    00:57:44   
NCOMS        2012-09-31T23:00:07    00:28:53    00:16:36    00:10:59    00:56:28   
-----------------------------------------------------------------------------------
----------------------------------------------------------
entities  devices  access  interfaces  discoMem  modelMem
----------------------------------------------------------

194328     352     347     93620        729.58    0.00
194925     352     348     93948        729.01    726.38
194997     352     348     93996        725.57    728.89
-----------------------------------------------------------
Table 2. Output columns
Column Description
Domain Domain name.
Date_of_discovery Start date and time of the discovery.
collection Length of time spent collecting data. This is the sum of time spend in discovery phases 1-3.
processing Length of time spent in the final processing phase of discovery.
transfer Length of time taken for the Topology manager, ncp_model, to update NCIM following the discovery.
total Total time taken for the discovery. This is the sum of collection, processing and transfer.
entities Total number of entities discovered as reported by the Discovery engine, ncp_disco.
devices Number of devices discovered as reported by the Discovery engine, ncp_disco.
access Number of entities to which ncp_disco reported SNMP access interfaces.
interfaces Number of interfaces discovered as reported by the Discovery engine, ncp_disco.
discoMem Memory usage of the the ncp_disco process in MB.
modelMem Memory usage of the ncp_model process in MB.