This page provides configuration details for Microsoft SQL Server collectors.
To monitor Microsoft SQL Server with Database Visibility, you must be running the 2005 version or newer.
To configure an Azure SQL Managed instance, follow the configuration procedures of a Microsoft SQL Server Collector described in this topic.
|Create New Collector||Database Type||The database type that you want to monitor.|
|Agent||The Database Agent that manages the collector.|
|Collector Name||The name you want to identify the collector by.|
|Connection Details||Hostname or IP Address|
The hostname or IP address of the machine that your database is running on.
To monitor a cluster, specify the hostname or IP address of the listener of the cluster. See Monitor the Microsoft SQL Server Cluster to enable monitoring the MSSQL cluster.
The TCP/IP address of the port on which your database communicates with the Database Agent.
If you are using a Microsoft SQL Server cluster, specify the listener port of the cluster.
To enable monitoring of all the nodes in a cluster, you must enable the monitoring of the cluster. This allows the agent to automatically discover all the nodes present in a cluster. See Monitor the Microsoft SQL Server Cluster
|Windows Authentication||Click to enable Windows authentication when connecting to the database.|
|Custom JDBC Connection String||The JDBC connection string generated by the database agent, for example, |
|Username and Password||Username||The name of the user who is connecting to and monitoring the database through the Database Agent. The user should have the permissions described in User Permissions for Microsoft SQL Server.|
|Password||The password of the user who is connecting to and monitoring the database through the Database Agent.|
|CyberArk||Click to enable CyberArk for database username and password. When CyberArk is enabled, information about Application, Safe, Folder, and Object is required to fetch the username and password for your database. To use CyberArk with Database Visibility, you must download the JavaPasswordSDK.jar file from the CyberArk web site and rename the file to cyberark-sdk-9.5.jar. Then, you must copy the JAR file to the lib directory of the database agent zip file.|
Click to monitor multiple database instances in a consolidated view, and aggregate metrics of multiple databases. To monitor a custom cluster, you can add additional hostname or IP address, and port details for each sub-collector. You can add up to a total of 29 sub-collectors. Thereby, 30 databases can be monitored in a custom cluster. In addition to the licenses consumed by the main collector, each sub-collector consumes one or more licenses, depending on the database type.
|Connection Properties||Click to add a new JDBC connection property or edit an existing property for relational databases.|
|Exclude Databases||The databases that you want to exclude, separated by commas.|
|Monitor Operating System||See this page for more details, Configure the Database Agent to Monitor Server Hardware.|
To handle High Availability (Multi-AZ) for Amazon RDS, set the databaseName JDBC connection string property to a user database.
Monitor Microsoft SQL Server
You can monitor the SQL Server either using an existing user account or by creating a new user account, with relevant privileges.
Monitor the Microsoft SQL Server Cluster
You can monitor all the nodes in the availability group of an MSSQL database server 2012 or later.
To enable monitoring of all the nodes, you must enable the
dbagent.mssql.cluster.discovery.enabled property either at the Controller level or at the agent level.
This property is disabled by default.
You can monitor the SQL server using either of the following authentication methods:
- Windows authenticated account (if the Database Agent is running on Windows)
- SQL Server authenticated account (if the Database Agent is running on Windows or Linux)
Before you Begin
To connect to the SQL Server database using a Windows authenticated account, perform the following:
● Select Windows Authentication checkbox when creating the collector using "Create New Collector" dialog.
Do not specify the username and password when updating database connection details.
● Specify the path to the Database Agent authentication library as follows:
● Ensure that the Windows account user has appropriate privileges to authenticate the database server and can start the database agent.
● Change the logon credentials of the service to the Windows account with SQL Server access, if using a Windows service to run the Database Agent.
Server Level Permissions for SQL Server Logon
To create a new SQL Server user (with minimum permissions required to monitor), perform the following steps:
- Create a new login for the AppDynamics SQL Server Database Collector, such as AppD_User, using SQL Server Management Studio (SSMS).
To map the new user to "master" and "msdb" databases, click "master" and "msdb" under Users mapped to this login.
User mapping to "master" and "msdb" are mandatory for monitoring. To view object information in the Object Browser screens, additional mapping to other databases is required.
After creating the login, grant the following privileges to the user by substituting AppD_User with the name you specified on the Login - New window:
Optional Object Permissions for SQL Server
The following object permissions are required for optional screens within the Database (DB) Visibility user interface:
Object Browser > Users
securityAdmin role is required
Object Browser > Storage
To view object storage metadata, user mapping to other databases of interest is required.
public role is required
Object Browser > Job Status
|Object Browser > Error Log|
securityAdmin role required
|Object Browser > Database|
To view object storage metadata, user mapping to other databases of interest is required e.g. Table/View metadata.
public role required.
Following image shows how users are mapped to AdventureWorks2012 database: