This page applies to an earlier version of the AppDynamics App IQ Platform.
See the latest version of the documentation.

Skip to end of metadata
Go to start of metadata

The Database Agent Collector is a process that runs within the Database Agent to communicate with databases, servers, and infrastructure to collect metrics. Configure one Collector for each database instance that you want to monitor. You can also configure the Collector to monitor the machine hosting the database instance the Collector is monitoring. Each database server you monitor consumes one license. In the case of SQL Server, with one license you can monitor many database instances. The Database Agent can support up to 200 Collectors. To monitor 100 + database instances, increase the initially allocated heap size for the Database Agent JVM. 

If a database backend has the same hostname, port number, and database type as a database server already configured in a database Collector, the database backend is automatically matched with the Collector, and drill downs from the Application Flow Map, Tier Flow Map or Node Flow Map to Database Monitoring are enabled.

Prepare for Collector Configuration

Be sure that you have the required permissions to monitor your databases. See Database Monitoring Requirements and Supported Environments for more information.

Add a Database Collector

For required roles and permissions required to add, edit, and create collectors, see Roles and Permissions.

Complete each field of the Create New Collector dialog and then click OK. Your database administrator can provide you with the necessary details.

The Configuration > Collectors window lists all collectors. Monitored database instances appear on the Database Monitoring and Databases windows, and on the AppDynamics Pro Controller Home page. 

You can link a database on the application flow maps to a database instance monitored by Database Monitoring.

Descriptions of the fields in the Create New Collector dialog follow.

Complete the Connection Details Section

Use the following to help you complete the fields of the Add New Collector and Edit Collector windows. The fields that display depend on the type of Database Collector you selected.

Database Type: From the list, select the database type the Collector will monitor.

Database Agent: From the list, select the Database Agent that manages the Collector. If you only have one Database Agent, then its name will be Default Database Agent unless you changed the name on the Database Agent startup command using the Database Agent Name configuration property.

Name: (for all databases) Enter a name to identify the database Collector as you want it to appear in the UI.

Hostname or IP Address: (for all databases) Specify the hostname or IP address of the machine serving the database. The hostname or IP address appears in the Hostname column of the Collector Administration window.

EnterpriseDB: Click if your PostrgreSQL database installation is an EnterpriseDB distribution. 

Failover Partner(for SQL Azure only) If you use Database Mirroring, enter the hostname or the IP address of the Failover Partner here. If you specify this field you must also specify the Database field as described above.

Listener Port: (for all databases) Specify the TCP/IP address of the port the database uses for communicating with the AppDynamics Database Monitoring agent. The database list port appears in the Listener Port column of the Collector Administration window.

Custom JDBC Connection String(for all databases) Normally, the Database Agent generates a JDBC connection string based on the information provided in the collector configuration dialog. You also have the option to specify a custom connection string, which can be useful for setting custom authentication options. For example, you can use LDAP to authenticate with an Oracle database, by using a connection string such as: "jdbc:oracle:thin:@ldaps://ldap.acme.com:7777/sales,cn=OracleContext,dc=com". If you are using Kerberos authentication on your Sybase Database, see Monitor Sybase Databases Using Kerberos Authentication for important information.

Window Authentication: (for Microsoft SQL Server) Specify whether or not to use Windows authentication to connect to the database. When selected, the authorization fields are not used because no authorization is required.

Use Service Name: (for Oracle) Select if the field that follows is the service name.

SID or SERVICE_NAME: (for Oracle) Specify the service name or SID of the database to monitor. Click either SID or SERVICE_NAME to indicate which database identifier you are using.

Connect as a sysdba: (for Oracle)  Click if you want to connect as user sys and enable password files. Running the Collector using a sysdba account allows the Collector to monitor an Oracle instance in standby mode, an instance that is used for failover which is being replicated from the main active instance.

Username: (for all databases) Specify the name of the user the Database Agent uses to connect to the database. This user must have the permissions specified in Configure Database User RolesThe user account used for monitoring a SQL Server database can be a Windows authenticated account (if the Database Agent is running on Windows) or SQL Server authenticated (if the Database Agent is running on Windows or Linux). 

Password: (for all databases) Specify the password of the user the Database Agent uses to connect to the database.

Logging Enabled:  (for all databases) Click to enable verbose mode logging, which logs all communications between the Controller and the Collector. Enable only during troubleshooting because logging can consume a lot of disk space. If you have enabled logging, you can click the logging icon in the Log column of the Collector Administration window to view the log file. The log files are located in the <db_agent_home>\agent directory and have the format <CollectorName>_out.log and <CollectorName>_err.log. 

Hardware Monitoring

For information on the fields you must complete in order for the Database Agent to monitor the database server in addition to the database server, see Configure the Database Agent to Monitor Server Hardware.

Verify Collector Setup

Once the Collector is up and running, in just a short time you can start viewing the historical activity data. 

The Collector configuration window now has a collector icon you can click to edit the details of the collector if required. The Collector will also appear in the list of Databases shown in the left navigation menu. It might take a few minutes before the Collector and its metrics are reported.

From the left navigation menu, click Databases to see a high-level view of the activity of all the configured Collectors.

Click the name of the database to see more details of the metrics AppDynamics Database Monitoring has captured.

For information on using and interpreting the Collector windows, see Monitor Databases and Database Servers.

Edit a Database Collector

From the Collectors window, you can edit any of the details of the collector except the type of database platform to monitor.

Delete a Database Collector

From the Collectors window, you can delete a database Collector.

Troubleshooting Collector Problems

Collectors that have not been configured correctly, or that cannot connect to the database for any reason, will show an error on the Databases overview page and individual database dashboards. Hovering over the error icon displays the potential reason for the error.

If your Collector isn't reporting any metrics after a few minutes, and you know the database is up and running with activity, check the Events window. Agent Diagnostic Events can appear if the password is incorrect or communication errors have occurred. The message summaries on the Events window can help you diagnose and troubleshoot Collector problems.

Check the collector configuration to ensure all the values you entered are correct.

Ensure that your Database Agent has network connection to the databases you want to monitor along with the required permissions.  See Database Monitoring Requirements and Supported Environments.

Watch the Video

For full-screen viewing, click Creating Database Collectors.