CA Unified Infrastructure Management

Transcription

1 CA Unified Infrastructure Management Probe Guide for JDBC Response Monitoring v1.2 series

2 Copyright Notice This online help system (the "System") is for your informational purposes only and is subject to change or withdrawal by CA at any time. This System may not be copied, transferred, reproduced, disclosed, modified or duplicated, in whole or in part, without the prior written consent of CA. This System is confidential and proprietary information of CA and protected by the copyright laws of the United States and international treaties. This System may not be disclosed by you or used for any purpose other than as may be permitted in a separate agreement between you and CA governing your use of the CA software to which the System relates (the CA Software ). Such agreement is not modified in any way by the terms of this notice. Notwithstanding the foregoing, if you are a licensed user of the CA Software you may make one copy of the System for internal use by you and your employees, provided that all CA copyright notices and legends are affixed to the reproduced copy. The right to make a copy of the System is limited to the period during which the license for the CA Software remains in full force and effect. Should the license terminate for any reason, it shall be your responsibility to certify in writing to CA that all copies and partial copies of the System have been destroyed. TO THE EXTENT PERMITTED BY APPLICABLE LAW, CA PROVIDES THIS SYSTEM AS IS WITHOUT WARRANTY OF ANY KIND, INCLUDING WITHOUT LIMITATION, ANY IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NONINFRINGEMENT. IN NO EVENT WILL CA BE LIABLE TO YOU OR ANY THIRD PARTY FOR ANY LOSS OR DAMAGE, DIRECT OR INDIRECT, FROM THE USE OF THIS SYSTEM, INCLUDING WITHOUT LIMITATION, LOST PROFITS, LOST INVESTMENT, BUSINESS INTERRUPTION, GOODWILL, OR LOST DATA, EVEN IF CA IS EXPRESSLY ADVISED IN ADVANCE OF THE POSSIBILITY OF SUCH LOSS OR DAMAGE. The manufacturer of this System is CA. Provided with Restricted Rights. Use, duplication or disclosure by the United States Government is subject to the restrictions set forth in FAR Sections , , and (c)(1) - (2) and DFARS Section (b)(3), as applicable, or their successors. Copyright 2014 CA. All rights reserved. All trademarks, trade names, service marks, and logos referenced herein belong to their respective companies. Legal information on third-party and public domain software used in this product is documented in the Third-Party Licenses and Terms of Use (

3 Contact CA Contact CA Support For your convenience, CA Technologies provides one site where you can access the information that you need for your Home Office, Small Business, and Enterprise CA Technologies products. At you can access the following resources: Online and telephone contact information for technical assistance and customer services Information about user communities and forums Product and documentation downloads CA Support policies and guidelines Other helpful resources appropriate for your product Providing Feedback about Product Documentation Send comments or questions about CA Technologies product documentation to To provide feedback about general CA Technologies product documentation, complete our short customer survey which is available on the support website at

4

5 Contents Chapter 1: General Overview 7 Chapter 2: Probe Deployment 9 Prerequisites and System Requirements... 9 Prerequisites... 9 Supported Platforms System Requirements Software Requirements Monitoring System Requirements Probe Deployment Information Chapter 3: Configuration 11 Probe Configuration Interface Probe Configuration Setup Tab Connections Tab Profiles Tab Attribute Substitutions Chapter 4: QoS Threshold Metrics 29 jdbc_response QoS Metrics jdbc_response Alert Metrics Default Settings Contents 5

6

7 Chapter 1: General Overview This description applies to probe version 1.2 The Java Database Connectivity SQL Queries Response Monitoring (jdbc_response) probe issues custom SQL queries to the database servers through the JDBC client interface. The probe measures the response time of the JDBC connection and the time that is required to gather data. The jdbc_response probe is a Java based probe that executes SQL queries using the Java Database Connectivity (JDBC) API. If a query completes, the probe evaluates its response time, number of returned rows and returned value. The probe currently supports monitoring SQL queries on the following databases: Microsoft SQL Server MySQL Oracle PostgreSQL. From version 1.2 onwards, the probe also supports: IBM DB2 IBM Informix This section contains the following topics: Documentation Changes (see page 8) Chapter 1: General Overview 7

8 Prerequisites and System Requirements Documentation Changes This table describes the version history for this document. Version Date What's New? 1.2 September 2014 Added information for IBM DB2 and IBM Informix support. Updated the General Tab topic for source override option. Updated the jdbc_response QoS Metrics topic. 1.1 August 2012 Updated information for Run Interval and Clear Severity of profiles. Added information for Debian and Ubuntu support for the probe 1.0 December 2009 Initial release of the probe. Related Documentation Documentation for other versions of the jdbc_response probe The Release Notes for the jdbc_response probe Monitor Metrics Reference Information for CA Unified Infrastructure Management Probes ( 8 Probe Guide for JDBC Response Monitoring

9 Chapter 2: Probe Deployment This section contains the following topics: Prerequisites and System Requirements (see page 9) Probe Deployment Information (see page 10) Prerequisites and System Requirements This section contains the prerequisites and system requirements for the jdbc_response probe. Prerequisites The jdbc_response probe, by default, installs the JDBC drivers for Microsoft SQL Server and Oracle databases. To monitor other databases, the appropriate driver, as a JAR file, must be downloaded and stored on a system from where the probe can access it. Note: For making connections and running SQL queries, a User name and Password is required for the databases being monitored. Download the drivers for the following databases and store at the default location of the driver files. The default location of the JDBC driver JAR file is [CA UIM Installation Directory] \probes\database\jdbc_response\lib folder. IBM DB2: Download the latest version of IBM DB2 JDBC driver from IBM Informix: Search for and download the latest version of IBM Informix JDBC driver from Note: You must register on the IBM website before you can download the IBM DB2 or IBM Informix drivers. MySQL: Download the latest version of MySQL JDBC driver from PostgreSQL: Download the latest version of PostgreSQL JDBC driver from Note: You must restart the probe after storing the driver files in the probe installation directory. Chapter 2: Probe Deployment 9

10 Probe Deployment Information Supported Platforms Refer to the Compatibility Support Matrix for the latest information about supported platforms. See also the Support Matrix for Probes for more specific information about the probe. System Requirements The jdbc_response probe should be installed on systems with the following minimum resources: Memory: 2-4 GB of RAM. This probe OOTB configuration requires 256 MB of RAM. CPU: 3 GHz dual-core processor, 32-bit or 64-bit. Software Requirements The jdbc_response probe requires the following software environment: Nimsoft Monitor Server 7.1 to 7.6 or CA Unified Infrastructure Management 8.0 or later Robot version 7.1 or later Java Virtual Machine version 1.6 or later (deployed as part of the probe package) Monitoring System Requirements This probe monitors the response time, row count and value from SQL queries. Probe Deployment Information There are three ways to distribute archive packages. You can distribute the package within the web-based Admin Console (for supported probes), from within Infrastructure Manager, or use the standalone Distribution application. See Probe Deployment for more information on deploying probes. 10 Probe Guide for JDBC Response Monitoring

11 Chapter 3: Configuration Configuring this probe will enable you to monitor the response time, row count and value from SQL queries. To configure the probe from the Infrastructure Manager, select it and right-click and select Configure or double-click on the probe. This will start the jdbc_response configuration user interface. This interface has three tabs; Setup, Connections, and Profiles. The first step in configuring this probe is to configure a connection to a database. Then configure a profile which will use that connection. Profiles define a query to be executed on the database. This section contains the following topics: Probe Configuration Interface (see page 11) Probe Configuration (see page 11) Probe Configuration Interface The jdbc_response probe configuration interface is installed when the jdbc_response probe is deployed. Probe Configuration This section describes the configuration concepts and procedures for setting up the jdbc_response probe. Chapter 3: Configuration 11

12 Setup Tab The Setup tab allows you to configure probe logging attributes. The fields in the above tab are explained below: Log File Defines the file where the probe logs information about its internal activity. Log Level Sets the level of details written to the log file. Log as little as possible during normal operation, to minimize disk consumption. 12 Probe Guide for JDBC Response Monitoring

13 Connections Tab The Connections tab displays a list of configured database connections. This tab allows you to add, edit, and delete database connections. Chapter 3: Configuration 13

14 Edit a Database Connection This functionality allows you to edit a database connection. Follow these steps: 1. Click the Connections tab. A list of configured database connections appear. 2. Right-click on a database connection. The context menu appears. 3. Click Edit. The Edit Connection dialog appears. Note: You can also double-click a database connection to display the Edit Connection dialog box. 14 Probe Guide for JDBC Response Monitoring

15 The Edit Connection dialog is used to change attributes of a database connection definition. The following fields can be configured: Win/Domain Authorization If selected, the profile uses the Windows integrated security for MS SQL Server to connect to the database. Username and password is required for windows machine on which database is installed since Windows domain authentication will be used. Database URL The JDBC URL for connecting to the database. Example: IBM DB2 jdbc:db2://ip address:port Number/Database Name IBM Informix jdbc:informix-sqli://ip address:port Number/Database Name:INFORMIXSERVER=Server Name Micrsoft SQL Server MySQL Oracle jdbc:sqlserver://ip address:port Number;DatabaseName=Database Name jdbc:mysql://ip address:port Number/Database Name jdbc:oracle:thin:@ip address:port Number:Database Name PostgreSQL Database Driver jdbc:postgresql://ip address:port Number/Database Name The Java class name of the JDBC driver for the database. Examples: com.ibm.db2.jcc.db2driver com.informix.jdbc.ifxdriver com.microsoft.sqlserver.jdbc.sqlserverdriver com.mysql.jdbc.driver oracle.jdbc.driver.oracledriver org.postgresql.driver Chapter 3: Configuration 15

16 Driver Path User ID The absolute file system path to the JDBC driver for the database. Example: [CA UIM Installation Directory]/probes/database/jdbc_response/lib/sql_drv.jar Note: For Microsoft SQL Server and Oracle databases, drivers are already installed with the probe. As a result, this field is disabled for Microsoft SQL Server and Oracle databases. Defines the username with access privileges to make a JDBC connection to the database and execute a query. This property is not used if "Win/Domain Authorization" is selected. Password Timeout Defines the password for the selected user. Defines the timeout value for attempting a connection. Connection Error Alarm Severity Specifies the severity of the error alarm sent to the hub in the event that a connection cannot be made to the database. Connection Error Alarm Message Specifies the message sent in the error alarm. (Refer section Attribute Substitutions (see page 27).) Connection Established Alarm Severity Specifies the severity of the clearing alarm sent to the hub in the event that a connection is made to the database. Connection Established Alarm Message Specifies the message sent in the clearing alarm. (Refer section on Attribute Substitutions (see page 27).) In addition to configuring the connection, this dialog is used to test the connection by clicking the Test button. If a connection can be made to the database using the current configuration the "LED" will turn green. Otherwise the "LED" will remain black. If the test fails, check the log file for error messages. 16 Probe Guide for JDBC Response Monitoring

17 Profiles Tab The Profiles tab shows the list of configured profiles. Profiles are associated with configured connection and contain the SQL query to be executed. This tab is used to select whether a profile is active or not. This tab is also used to edit, copy, delete or run a current profile. New profiles can also be created here. The Run now option will run the profile that is currently being used by the running probe. If changes have been made to a profile, they will not be run until the probe is restarted. Refer the description of Test button of the SQL Query Tab (see page 20) for testing changes without restarting the probe. To edit a profile, right-click a profile and select Edit or double click on the desired profile. This will launch the Edit Profile dialog. Chapter 3: Configuration 17

18 General Tab The General tab of the Edit Profile dialog is used to set general attributes of the profile. The fields in the above tab are explained below: Name Defines a unique name for this profile. Description Provides the description of this profile. Connection Defines the database connection to be used for this profile. 18 Probe Guide for JDBC Response Monitoring

19 Alarm Source Override Overrides the default alarm source with the provided value. The default value for the alarm source is the robotname where the probe is deployed. QoS Source Override Overrides the default QoS source with the provided value. The default value for the QoS source is the robotname where the probe is deployed. Important! Recommendation is to not change the source override fields after the initial configuration. In case you change the QoS source later, multiple graphs display on the Unified Service management (USM) Metrics view (one for every QoS source value). Further, it is also recommended to keep identical source for both alarm and QoS. Timeout error Specifies the severity level of the alarm which is generated when the SQL query fails to validate. Query Timeout Specifies the time interval after which the SQL query timeout alarm is generated. Run Interval Specifies the time interval after which a profile runs automatically. Chapter 3: Configuration 19

20 SQL Query Tab The SQL Query tab of the Edit Profile dialog is used to specify the query to be run by this profile. The query can be entered in the Simple Query section, or read from a file specified in the From File section. The fields in the above tab are explained below: Simple Query If selected, the query as currently entered can be tested with the Test button. From File If selected, the file entered must reside in the probe home directory on the probe system. For example, if "query.txt" is entered, the probe will look for the following file: "[CA UIM Installation Directory]/probes/database/jdbc_response/query.txt". Once the filename is entered the query can be loaded by clicking on the Read File button. If the file is successfully read, the query can be tested by clicking the Test button. 20 Probe Guide for JDBC Response Monitoring

21 Response Time Tab The Response time tab of the Edit Profile dialog helps to configure alarms and QoS messages based on the total response time of running the profile. The total response time includes connect, prepare statement, execute query, check results, and disconnect. The fields in the above tab are explained below: Alarm If Alarm is selected, the threshold values defined in this dialog will be applied to the total response time of this profile. High Threshold Defines the high value alarm that will be sent if the response time of the profile exceeds the Value setting in milliseconds. The Severity setting is the alarm severity and the message defines the alarm message. (Refer section Attribute Substitutions (see page 27).) Chapter 3: Configuration 21

22 Low Threshold Clear QoS Defines the low value alarm that will be sent if the response time of the profile exceeds the Value setting in milliseconds. The severity setting is the alarm severity and the message defines the alarm message. (Refer section Attribute Substitutions (see page 27).) Clears or maintains history of response time alarms as per the alarm severity level specified in Clear Severity. Note: By default, the Clear Severity level is set to inactive to maintain alarm history in the alarm console. Message specifies the alarm message which is displayed when a response time alarm is generated. For more information about message attributes, refer section Attribute Substitutions (see page 27).) If QoS is selected, a QOS_JDBC_RESPONSE message will be sent to the hub for the response time of this profile. 22 Probe Guide for JDBC Response Monitoring

23 Row Count Tab The Row count tab of the Edit Profile dialog is used to configure alarms and QoS messages based on the number of rows returned by the SQL query defined in this profile. The fields in the above dialog are explained below: Operator Defines what comparison operator will be used to check the number of rows returned against the threshold values. For example if the Operator is "<=" and the threshold value is 10 and the number of rows returned is 9, an alarm will be sent for that threshold. If the next query returns 11 rows, a clear alarm (if configured) will be sent. Chapter 3: Configuration 23

24 Alarm If Alarm is selected, the threshold values defined in this dialog will be applied to the number of rows read by the query of this profile. High Threshold Defines the high value alarm that will be sent if the number of rows of the profile exceeds the Condition and Value settings. The Severity setting is the alarm severity and the message defines the alarm message. (Refer section on Attribute Substitutions (see page 27).) Low Threshold Clear QoS Defines the low value alarm that will be sent if the number of rows of the profile exceeds the Condition and Value settings. The Severity setting is the alarm severity and the message defines the alarm message. (Refer section on Attribute Substitutions (see page 27).) Clears or maintains history of row count alarms as per the alarm severity level specified in Clear Severity. Note: By default, the Clear Severity level is set to inactive to maintain alarm history in the alarm console. Message specifies the alarm message which is displayed when a row count alarm is generated. For more information about message attributes, refer section on Attribute Substitutions (see page 27). If QoS is selected, a QOS_JDBC_ROWS message will be sent to the hub for the number of rows returned by this profile. 24 Probe Guide for JDBC Response Monitoring

25 Value Tab The Value tab of the Edit Profile dialog is used to configure alarms and QoS messages based on the value of a selected column in the first row of the results returned by the SQL query defined in this profile. The fields in the above tab are explained below: Alarm If Alarm is selected, the threshold values defined in this dialog will be applied to the value returned by the query of this profile. Chapter 3: Configuration 25

26 Comparison Column Defines what type of comparison will be used to check the returned value. Selections available are numeric, character, or regular expression. If character or regular expression are selected only the "=" and "!=" Operators are valid. The "=" Operator is the default for those comparisons. If regular expression is selected, a Java regular expression as defined in the Java Pattern class is used to check the value. Defines which column's value will be checked. The value is always from the first row if multiple rows are returned. Operator Defines what comparison operator will be used to check the value returned against the threshold values. For example if the Comparison is numeric, the Operator is "<=", the threshold value is 10 and the value returned for the selected column of row 1 is 9, an alarm will be sent for that threshold. If the next query returns a value of 11, a clearing alarm (if configured) will be sent. High Threshold Defines the high value alarm that will be sent if the value of the profile exceeds the Condition and Value settings. The Severity setting is the alarm severity and the message defines the alarm message. (Refer section Attribute Substitutions (see page 27).) Low Threshold Clear QoS Defines the low value alarm that will be sent if the value of the profile exceeds the Condition and Value settings. The Severity setting is the alarm severity and the message defines the alarm message. (Refer section Attribute Substitutions (see page 27).) Clears or maintains history of value alarms as per the alarm severity level specified in Clear Severity. Note: By default, the Clear Severity level is set to inactive to maintain alarm history in the alarm console. Message specifies the alarm message which is displayed when a value alarm is generated. For more information about message attributes, refer section Attribute Substitutions (see page 27).) If QoS is selected, a QOS_JDBC_VALUE message will be sent to the hub for the value returned by this profile. 26 Probe Guide for JDBC Response Monitoring

27 Attribute Substitutions The messages defined for all alarms can use attribute substitution to make the message unique for the particular profile, connection and threshold. The pattern must be separated by white space for substitution to occur. The following attribute substitution patterns can be placed in the message definition: Pattern $profile Substitution The profile name. $url $query $con $threshold $time $rows $value $condition The JDBC URL of the profile's connection. The SQL query for this profile. The name of the connection for this profile. The value of the threshold crossed. The response time measured. The number of rows returned by the query. The value of the selected column in row 1 of the query. The condition selected for the threshold ("=", "!=", etc.). Chapter 3: Configuration 27

28

29 Chapter 4: QoS Threshold Metrics CA Unified Infrastructure Management probes ship with the default QoS threshold values set. The default threshold values give an idea of the type of values to enter in the metrics fields. To help in tuning thresholds and reducing false-positive alarms, this section describes the QoS metrics and provides the default QoS thresholds. This section contains the following topics: jdbc_response QoS Metrics (see page 29) jdbc_response Alert Metrics Default Settings (see page 29) jdbc_response QoS Metrics The following table describes the QoS metrics that can be configured using the JDBC Response Monitoring probe. Monitor Name Units Description QOS_JDBC_RESPONSE Milliseconds Returns the query response time of the JDBC connection. QOS_JDBC_ROWS Rows Displays the number of rows returned by the query. QOS_JDBC_VALUE Value Displays the value returned by the query. jdbc_response Alert Metrics Default Settings This section contains the alert metric default settings for the jdbc_response probe. Metric Name Warning Threshold Warning Severity Error Threshold Error Severity Response time NA Warning NA Major Row count NA Warning NA Major Description Monitors the alarm value that is sent if the response time of the profile exceeds the Value setting in milliseconds. Monitors the alarm value that is sent if the number of rows of the profile exceeds the Condition and Value settings. Chapter 4: QoS Threshold Metrics 29

30 jdbc_response Alert Metrics Default Settings Metric Name Warning Threshold Warning Severity Error Threshold Error Severity Value NA Warning NA Major Description Monitors the alarm value that is sent if the value exceeds the threshold value. 30 Probe Guide for JDBC Response Monitoring