Configure Storage Analyzer

This chapter explains how to configure the monitoring of any supported endpoint, define the Storage Analyzer various customizable parameters, and fine-tune the Java settings.

Configuring Endpoints Monitoring

Step 1 - Add an Endpoint

To add a new Endpoint (host) to your monitoring environment

  1. Click KMs > Storage Analyzer from the Web Console
  2. Click the Monitored Endpoints… button
  3. Click the New Endpoint button
  4. Configure the following properties:
    Property Description
    Hostname or IP Address Enter the name of the hostname or the IP address of the endpoint you wish to monitor.
    Associate to a Specific FQDN (Optional) Enter the FQDN to associate the endpoint to another device in TrueSight. The FQDN uniquely distinguishes a device from any other system and ensures that a device monitored via their management cards or through controllers, for example, is properly identified.
    Storage Intelligence Adapter Select the Storage Intelligence Adapter corresponding to the endpoint you wish to monitor. The list corresponds to the Storage Intelligence Adapters (*.si files) installed on the PATROL Agent.
    Enable Hardware Monitoring Select to enable the monitoring of the hardware components for the selected storage platform via Hardware Sentry KM. This option is only available when Hardware Sentry KM for PATROL version 11.0.01 or higher is installed and loaded on the PATROL Agent and if the selected Storage Intelligence Adapter contains the hardware connector details. Refer to Install the KM for details.
    Internal ID ID to be used to store the system configuration in the PATROL Agent configuration. This Internal ID is automatically generated based on the provided Hostname or IP Address but can be edited if needed.

Storage Analyzer comes with a library of Storage Intelligence Adapters (*.si files) that describe how to discover endpoints and retrieve capacity and performances data for all their discovered components. Make sure to have properly installed the latest Storage Intelligence Library.

Step 2 - Configure the Connection Settings

Provide the credentials and define the connection preferences to connect to the endpoint.

Property Description
Username Enter the Username that Storage Analyzer will use to access the endpoint.
Password Enter the password that Storage Analyzer will use to access the endpoint.
Port Enter the port number Storage Analyzer will use to connect to the endpoint. By default this is set to the default port used by the selected Storage Platform.
Encryption For encrypted connections, select the Encryption option.

Step 3 - Configure the Advanced Settings (optional)

The default configuration of the Advanced Settings are optimized to fit most endpoints and should remain unchanged. It is recommended to contact Sentry Support for advice.

Property Description
Discovery Interval Turn ON to specify the interval at which Storage Analyzer must perform a discovery on the endpoint. If left OFF, the Default Discovery Interval is used. This property can be set from the KM Engine section of the KM > Storage Analyzer page.
Polling Interval Turn ON to specify the interval at which Storage Analyzer must perform a polling to retrieve performance and capacity data from the endpoint. If left OFF, the Default Polling Interval is used. This property can be set from the KM Engine section of the KM > Storage Analyzer page.
Engine Timeout Turn ON to specify the time allocated for querying and endpoint.
Query Timeout Turn ON to specify the time allocated to individual queries.
Disable Volume Monitoring Turn ON to disable the discovery and data collect requests for the volumes on the endpoint. Volumes will no longer appear in the Web Console.

KM Settings

Alert Settings

You can define the way Storage Analyzer notifies you when alert conditions are detected on a monitored parameter. The alert content can include macros that will be replaced at runtime.

Alert Actions Description
Annotation To display a message at the annotation point of the parameter graph.
PATROL Event To customize PATROL Event types and related event content.

  • Storage Errors: To select the type of event to trigger upon storage failures - Storage Analyzer Specific (SKM_MAIN/StorageProblem) or Generic (STD/41) and customize the event content.

  • Collection Errors: To select the type of event to trigger upon collection failures - Storage Analyzer Specific (SKM_MAIN/CollectionProblem) or Generic (STD/41) and customize the event content.
Write to a Log File To add a user-defined entry to the Log file.

Customizing Alert Content

Storage Analyzer allows you to customize the content of Alert Actions with macros when a storage failure is detected. The following macros can be used to obtain more details about the problem. They will be replaced at runtime.

Macros Description
%{ALARM_TYPE} Type of the triggered alert.
%{COMMA} Inserts a comma.
%{DATE} current date in the YYYY-MM-DD format.
%{EOL} Inserts carriage return.
%{ENDPOINT_CLASS} Endpoint class name: SKM_ENDPOINT.
%{ENDPOINT_CLIENTTIMEOUT} Configured client timeout when connecting to the endpoint.
%{ENDPOINT_COLLECTIONSTATUS} Collection status of the endpoint.
%{ENDPOINT_COLLECTIONSTATUSINFORMATION} Collection status information of the endpoint.
%{ENDPOINT_DOMAIN} Domain of the targeted endpoint.
%{ENDPOINT_ENGINETIMEOUT} Configured engine timeout when connecting to the endpoint.
%{ENDPOINT_FQDN} Fully qualified domain name of the targeted endpoint.
%{ENDPOINT_ID} ID of the endpoint.
%{ENDPOINT_IPADDRESS} IP address of the endpoint.
%{ENDPOINT_HOSTNAME} Hostname of the endpoint.
%{ENDPOINT_PORT} Port number used to connect to the endpoint.
%{ENDPOINT_PROTOCOL} Protocol used to connect to the endpoint.
%{ENDPOINT_TOKENID} TrueSight token ID for the endpoint.
%{ENDPOINT_USERNAME} Username used to connect to the endpoint.
%{DEVICE_DOMAIN} Domain of the TrueSight device to which the object is attached.
%{DEVICE_FQDN} Fully qualified domain name of the TrueSight device to which the object is attached.
%{DEVICE_HOSTNAME} Hostname of the TrueSight device to which the object is attached.
%{DEVICE_IPADDRESS} IP address of the TrueSight device to which the object is attached.
%{DEVICE_METAFQDN} MetaFQDN of the TrueSight device to which the object is attached.
%{DEVICE_METATOKENID} MetaTokenID of the TrueSight device to which thethe object is attached.
%{OBJECT_CLASS} Class name of the object to which the alert action belongs.
%{OBJECT_ID} PATROL ID of the object triggering the alert.
%{OBJECT_LABEL} Display name of the object triggering the alert.
%{OBJECT_TYPE} Type of the object triggering the alert (“Controller”, “Physical Disk”, etc.).
%{PARAMETER_ALARM1MAX} Alarm1 maximum range of the parameter triggering the alert.
%{PARAMETER_ALARM1MIN} Alarm1 minimum range of the parameter triggering the alert.
%{PARAMETER_ALARM1NTIMES} Number of consecutive times the parameter triggering the alert must report a value within the alarm1 range before the alert occurs.
%{PARAMETER_ALARM1TYPE} Alarm alert type of the parameter triggering the alert (OK, WARN, ALARM).
%{PARAMETER_ALARM2MAX} Alarm2 maximum range of the parameter triggering the alert.
%{PARAMETER_ALARM2MIN} Alarm2 minimum range of the parameter triggering the alert.
%{PARAMETER_ALARM2NTIMES} Number of consecutive times the parameter triggering the alert must report a value within the alarm2 range before the alert occurs.
%{PARAMETER_ALARM2TYPE} Alarm2 alert type of the parameter triggering the alert (OK, WARN, ALARM).
%{PARAMETER_BORDERMAX} Border maximum range of the parameter triggering the alert.
%{PARAMETER_BORDERMIN} Border minimum range of the parameter triggering the alert.
%{PARAMETER_BORDERNTIMES} Number of consecutive times the parameter triggering the alert must report a value outside the border range before the alert occurs.
%{PARAMETER_BORDERTYPE} Border alert type of the parameter triggering the alert (OK, WARN, ALARM).
%{PARAMETER_NAME} Name of the parameter triggering the alert.
%{PARAMETER_STATUS} Status of the parameter.
%{PARAMETER_TITLE} Title of the parameter.
%{PARAMETER_UNITS} Units of the parameter.
%{PARAMETER_VALUE} Value of the parameter triggering the alert.
%{PROBLEM} Describes the problem that triggered the alert for the parameter.
%{RECOMMENDED_ACTIONS} Describes the recommended action to solve the problem for the parameter triggering the alert.
%{SEMICOLON} Inserts a semicolon.
%{TIME} Time in HH:MM:SS format.

Additional time/date formats can be specified as described in the Time and Date Macros section.

KM Engine Settings

You can configure and fine tune some global settings that will determine Storage Analyzer default behavior. These properties will apply to any component monitored by the Agent when relevant.

Current Configuration Mode

Storage Analyzer can either be used with the Monitoring Studio Web console (Classic Mode) or BMC TrueSight Operations Management (CMA Mode). When the KM is used with BMC TrueSight, operation settings cannot be customized via the Web interface. To force the configuration from the Web console, turn ON the Force Classic Configuration Mode.

You will be prompted to reinitialize Storage Analyzer. Click YES to reinitialize the KM immediately or NO to save this setting in the configuration. Press the REINITIALIZE button at the bottom of the page, when you are ready to reinitialize Storage Analyzer or if you want to customize the reinitialization options. Refer to the Reinitialize section for details.

Once forced to Classic Mode, the KM stops processing the Storage Analyzer policies from BMC TrueSight.

Clear Alerts for Collection Error Count

Storage Analyzer automatically clears alerts on the Collection Error Count parameter after 2 hours and 15 minutes. You can customize this property by entering another value in Automatically Clear Alerts on the KM’s Collection Error Count After….

Tuning

Storage Analyzer allows you to customize several configuration properties that can impact the KM performance.

Property Description Default
Discovery Interval The default frequency at which Storage Analyzer performs discoveries to detect endpoints or detect those that have gone missing. 1 hour
Polling Interval The default frequency at which Storage Analyzer polls the managed systems to collect endpoints parameters. 2 minutes
Note: These settings apply by default to all endpoints for which no specific discovery and polling intervals have been configured at the endpoint level.

Missing Device Settings

Storage Analyzer enables you to customize the alert behavior for some critical parameters:

Property Description Default
Missing Device Detection To enable (ON) or disable (OFF) the detection of missing devices. When a device that was previously detected in the system is no longer found, its Present parameter goes into alarm.

The missing device detection feature does not apply to storage pools nor volumes.
ON
Clean-up Missing Devices on Startup To remove all missing devices from the Web console upon a PATROL Agent restart. OFF

Download Configuration

You can export Storage Analyzer global settings as a pconfig file (.CFG) that can be imported into a TrueSight CMA policy. All the Agents using the policy will therefore share the same Storage Analyzer Global Settings.

Java Settings

To operate correctly, Storage Analyzer requires that Java 1.8.00 or higher and a Java Runtime Environment (JRE) are installed on the same system that runs the PATROL Agent.

The Java Settings page displays information about the JRE currently in use and a list of all the JREs installed on the monitored system. You can also configure the following options to fine-tune the Java properties:

Options Description
Automatically Select Appropriate JRE Turn ON to let Storage Analyzer automatically find and use the most compatible JRE at the initial discovery that occurs when the PATROL Agent and Storage Analyzer start.
Execute the JVM as an Alternate User Turn ON to display the configurable options. By default, the Java process is launched with the same credentials as the PATROL Agent. If the PATROL Agent’s default account does not have sufficient privileges to perform the operations required by the Java Collection Hub, another user account can be provided.
Java Minimum Heap Size To customize the minimum size (in MB) of the Java Hub Heap Memory according to your environment requirements. By default, the minimum size is set to 128 MB.
Java Maximum Heap Size To customize the maximum size (in MB) of the Java Hub Heap Memory according to your environment requirements. By default, the maximum size is set to 2048 MB.
Disable JRE Pre-Validation By default, Storage Analyzer checks that the selected JRE meets the requirements. However, you can disable this option to bypass the compatibility check. Use this option only if you are certain that the provided JRE is compatible even if the compatibility check fails. An unsuitable JRE will prevent Storage Analyzer to operate properly.
JVM Arguments To provide arbitrary arguments to the java -jar … command line that Storage Analyzer uses to launch the Java Collection Hub in the Command line options field. (For example, enter Xdebug -Xrunjdwp:transport=dt_socket,address=4711,server=y,suspend=n to launch Storage Analyzer in debug on a specific port).
Warning: The JVM needs to be restarted for the new settings to be taken in account.
Keywords:
storage km patrol