User Tools
Table of Contents
Performance Discovery Scripts
Author: Eoin Joy
These scripts are used to discover and parse the performance metrics from network elements in the system with the intent to store a certain number of them for trend analysis purposes.
Additional Configuration
performGetType
Determines what kind of retrieval will be done for the information, eg. SNMP_TABLE or HTTP_POST
performMib
Should the performGetType by SNMP_TABLE the Mib object that the table in contained in is needed.
Retrieve Path
Used for all types to determine either what URLs to retrieve, or what SNMP OIDs to poll.
Return Value
List< Map< String, String > > – A list of String to String maps containing a path and optional identifier value.
Inserted Variables
networkElement – NetworkElement – The controller that we wish to perform the sync on.
Parameter Populate
Used for HTTP_POST type syncs to determine what data should be inserted into the postData such as some JSON requests. Executed for every path in the pathMapList generated by the Retrieve Path script.
Return Value
Map< String, String > – The postData required for the given path.
Inserted Variables
jobType – JobType – Used to determine in the script which postData should be returned, eg. ALARM_SYNC or ALARM_SEVERITY_SYNC.
httpSession – GroovyHttpSessionManager – Holds the current session connected to the given controller.
path – String – The path to calculate the postData for.
url – String – The full URL (protocol + ipAddress + port + path) to calculate the postData for.
pathMap – Map< String, String > – The map containing the path and identifier data for this entry as calculated in the Retrieve Path script.
Perform Value Parse
This script takes the information retrieved at the paths provided by Retrieve Path and parses out the performance values. These performance values are stored along with when they were obtained to allow a limited historic view of the performance values over time.
Return Value
NetworkElementPerformBase – Part of a structure where a base has many keys, who each have many names, who each have a value for each time the sync has run for the past configured number of runs.
Inserted Variables
networkElement – NetworkElement – The controller the sync is being performed on.
pathResultMap – Map< String, String > – The combined results of the retrieved data from the paths generated in the Retrieve Path script.
voList – List< SnmpDataVO > – The list of results received from the SNMP type gets as SnmpDataVO objects.