How to create a new (custom) checkpoint using the sqlserver probe

Transcription

1 How to create a new (custom) checkpoint using the sqlserver probe Overview This guide provides the steps required to create and configure new (custom) checkpoints using the sqlserver probe. Custom checkpoints allow you to use your own preferred queries or stored procedures for database monitoring when the checkpoints provided out of the box do not satisfy your specific database monitoring requirements. This guide walks you through configuring and testing a custom checkpoint, configuring data collection (QoS), configuring alarms and alarm thresholds, and the use of restrictions on monitoring (Excludes/Includes). Note that the example used in this guide executes the new (custom) query against a specific database, not all databases. 1. Open the sqlserver probe GUI by double-clicking on the probe 2. Select the Templates tab in the GUI 3. Right-click in the Templates window and Select-> Create New Enter a Name for the new template checkpoint, e.g., UA_table_space and Click Ok 4. Select the Query Tab: 5. Click the Edit/New button -> then enter the Connection setup parameters 6. Click Test -> then click OK, and click OK again to close the connection setup window. The connection information (i.e. User ID, Password, and Server name) defined in this window must be the same as defined in the SQL Server Profile. If there are multiple profiles using different connections then the new/custom checkpoints must be converted to static and for each static checkpoint, the connection should match the appropriate connection used in the SQL Server profile. 7. Type/paste the query -> then Click Test -> it should yield the results and expected number of rows. You can test it first in the MS SQL Server Studio. You can create a file on the file system that contains the query, then click Read to read in the file content, for example: use CA_UIM8310 select s.name SchemaName, t.name TableName, i.name IndexName, i.index_id, p.data_compression_desc, sum(ps.used_page_count * 8) used, sum(ps.reserved_page_count * 8) reserved, sum(ps.row_count) rows, COUNT(*) parts from sys.schemas s with(nolock) join sys.tables t with(nolock) on (s.schema_id = t.schema_id) join sys.indexes i with(nolock) on (t.object_id = i.object_id) join sys.partitions p with(nolock) on (t.object_id = p.object_id and i.index_id=p.index_id) join 1

2 sys.dm_db_partition_stats ps with(nolock) on (p.partition_id = ps.partition_id) group by s.name, t.name, i.name, i.index_id, p.data_compression_desc having SUM(ps.row_count) > 0 Query File (Mandatory) -> Give any file name (Queries are stored in separate files in the probe folder, not in the configuration file itself ) The query file name can contain the full/absolute path as per above, otherwise the file will be stored in the probe work directory. A window should open displaying the query results: 2

3 Click the Close button to close the query results window. Tips You must run a successful Test any time you need to make any change to the query itself. If any dropdown windows are empty, run the query again via the Test button, and then the drop down values should be populated. Generating the query Test results is necessary for the probe to contain all information about retrieved columns and to be able to define all of the checkpoint variables. The query has to return at least one numeric column, which will be used as a checked (threshold/qos) value. Additional columns can be retrieved to be used in generated messages. 8. Message Variables -> Click Edit -> will show all the variables present in the select clause of the query. Variable of type string/character will only be considered as row key or information. Under Column use, the row key will be used to differentiate the rows retrieved by the query and will be used as part of the alarm suppression key and QoS definition. IMPORTANT: If you use more than one row identification value, you must separate each value with a period, for example: $SchemaName.$TableName.$IndexName You MUST click Edit/New and refresh the connection setup parameter s then click Read/Test to test the query again to populate the values in the Row Identification window using a dollar sign $ if they don t show in the drop-down window. Note also that once this is done when you setup the QOS thresholds in that portion of the GUI, you will see the column names in the variable section on the right hand side of the screen. Those variables can be used for custom alarm messages. 3

4 The row key can be created by concatenating several columns from the checkpoint definition i.e. row key will be selected among the select clause columns. Select at least one of the variables as 'value' type under Column use. Columns with values or columns that are designated as value type, will end up being displayed in the QOS->Metric field. 9. Row Identification Row identification is not considered as a row to be monitored and doesn't have anything to do with monitoring/filtering of resulted records. Essentially, if your query returns more than one line, you need to define unique row key(s). To see which variables you can use you need to type a dollar sign "$" into the Row identification line and a sub-list with all available/suitable variables will appear in the Row Identification window. The Row Identification field will contain the columns which were defined as row key in the Message Variable dialog window. 4

5 5

6 10. Enabling QOS data for your checkpoint Select the General Tab Click the Send Quality of Service checkbox Click the QoS List button. The QoS List window will open. Rt-click the window and select New to create your QoS definition. Using the drop down arrow, select the value in the Metric field for which you want to create QOS, e.g., for which used will be shown in the QOS like in this example. Note: The Metric field will automatically display the values which have been assigned type value in the Message Definition section under the Query tab. Object value will be displayed in the QOS definition properties target field in the Service Level Manager portlet when you view the QOS object properties. Note: This will show the values which have been assigned type row key in the Message Definition section under Query tab to uniquely differentiate the QOS. Note also that you must enter a value in the Max value window. If the QOS object should have a relevant maximum value, then enter it, e.g., 100. If it does not have a relevant maximum value you must still enter a value otherwise the message will be dropped by the data_engine due to 6

7 no samplemax value. In this case you can enter a number that cannot be reached such as Note that the Object variables (which end up represented as the QOS target) must be separated by a period. After you click Ok, you can rt-click to create more QOS definitions for other metrics that have numeric values such as reserved, rows, parts etc. 7

8 11. General Tab configuration settings Under the General tab set your sql timeout and adjust other settings if needed, and then move on to defining alarm thresholds. 8

9 12. Alarm Thresholds To define a threshold, double-click in the Thresholds window. The Threshold object name window should display the metrics you can choose for defining an alarm threshold (via the dropdown) Fill in the Alarm threshold value, condition, create a new alarm message using the Variables 9

10 Click Ok, Ok then Ok again and restart the sqlserver probe then wait for the monitoring Interval to pass and check the newly generated alarms in the Infrastructure manager (IM) alarm sub-console. Then adjust the custom alarm threshold if necessary. IMPORTANT: the alarm threshold Severity must be set higher than what is configured in the Setup section of the sqlserver probe GUI: IMPORTANT: You MUST select the Query Tab and choose Edit/New button to re-enter the connection parameters, then Click Ok to Test it, then also click the Test button to get the results of the query EACH TIME you need to make a change, e.g., edit your thresholds otherwise the drop down boxes will not be populated with objects you can select. 10

11 If you do not get any alarms after setting and saving the new threshold, a) click Edit/New to Test the connection and Click Ok, then b) Run the query by clicking the Test button again. Close the window then Click Ok. Click Ok then Yes to restart the probe then check for the alarms. Optional (does not have to be used): Key Column Name: focuses/filters the alarm on a given row that contains a specific value. Drop down values are only populated after connection setup and Test if query. Key Column Value: value specified here is the value from that variable/object in that row, and this will be compared with the value you manually defined in the Threshold value window. 13. Excludes/Includes Lists (optional but can be very useful) Excludes list allows you to define a list of patterns that you do not want to monitor for a checkpoint. Includes list allows you to specify the patterns to be included in the checkpoint. Select the Profiles Tab. Double-click the profile to open it Double-click the specific checkpoint to open it Check the desired checkbox for 'Use excludes' or 'Use includes" 11

12 Click the > button to open the list Rt-click->New to add a list Add a regular expression and test it to see the results (tables to exclude from monitoring). You can use AND/OR logic and you can add any number of patterns for exclusion. Then close the Test results window Click Ok in each subsequent window and then Ok again, to restart the probe. At this point those tables should be excluded from monitoring and no QOS should be collected and you should not see any new alarms for those tables as well. Tips Note that if you want to Use includes for a particular subset of tables, you may find that very useful and easier when the database environment contains a large number of tables. Notes on use of Stored Procedures You can create/use stored procedures for custom checkpoints much in the same way as you use queries but note that they must return only a single result set. If you use a stored procedure that yields more than one results set, e.g., exec sp_spaceused, when you click the Test button it will not return any rows. Also, the columns MUST have header information or that can cause problems as well. This guide was created using the following environment: sqlserver probe v4.94 CA UIM 8.3 Microsoft SQL Server (X64) Enterprise Edition (64-bit) 12