DB Debug Tool

The DB Debug tool in Applications Manager allows users to execute custom SQL queries directly against the databases being monitored or against remote servers. This tool provides flexibility in querying and extracting specific data beyond the standard monitoring metrics. Users can either:

• Query Monitors: Retrieve data from databases linked to existing monitors. This allows querying any metric, performance indicator, or event directly from the monitored databases.
• Query Remote Servers: Execute SQL queries on remote databases even if they are not currently monitored, enabling custom, ad-hoc reporting or analysis.

To simplify authentication, users can either:

• Use Credentials from Credential Manager: Credentials stored securely in the Credential Manager can be reused to authenticate and execute queries. This streamlines the process by avoiding the need to re-enter login details.
• Provide Custom Credentials: Users can manually enter custom credentials if they want to query a database using specific login information that differs from the saved credentials.

Configuring DB Debug tool

Follow the steps given below to configure the DB Debug tool:

1. Under Settings tab, click on the DB Debug Tools under the Self Help Tools section.
2. Select the Monitor Type you are querying or debugging.
3. Choose the host from the dropdown for which you need to perform the test. In case of new host, follow the steps below.
4. Enter the hostname/IP address of the Windows host for which the debugging needs to take place.
5. Select the Resolve IP Address for Host option to enable the tool to look up the host's corresponding IP address and use it to connect to the server and perform the test.
6. Enter the port number on which the database is running.
7. Enter the credential details like user name and password for authentication, or select the required credentials from the Credential Manager list after enabling the Select from Credential listoption.

   Note: The username specified for collecting data from the MS SQL database must have the Administrator role, or be assigned as db_owner or db_datareader for the master database. Alternatively, you can choose to provide Windows Authentication details.

8. Enable the Kerberos Authentication checkbox if you want to debug the existing monitor or remote server through Kerberos authentication.
9. Choose between SQL and Windows as the Authentication Type to select the method used to verify a user’s identity when connecting to an MS SQL Server.
10. Check the Connect Using Named Instance option to specify a specific instance name when connecting to the MS SQL Server.
11. Check the Force Encryption box to ensure that all data exchanged between the application and the SQL Server is encrypted for security reasons.
12. Choose between two types of JDBC (Java Database Connectivity) drivers in the Driver for SQL Server Connection field to connect to an MS SQL Server: the jTDS JDBC Driver or the Microsoft JDBC Driver.
13. Check the Select Metrics option to choose specific performance and health metrics for analysis, based on the availability of data in the corresponding tab.
14. Select the Run Query option to enter the query to be executed in the database. The query must be a valid SQL query.
15. Check the Use JDBC URL (Optional) option to manually enter a JDBC URL to connect to the database and run queries.

    Note: Ensure that the appropriate driver is selected in the Driver for SQL Server Connection option and that the correct username and password are provided in their respective fields when using the JDBC URL.

16. Specify the Timeout value, in seconds to wait for the query to execute. The value must be between 60 to 300 seconds.
17. Click Execute.

After the query is executed, the tool displays the results or any errors, depending on the outcome. The results can also be exported for further analysis or documentation.