Connection Details

Note: If you use Azure database for PostgreSQL, Database Agent only supports PostgreSQL and Microsoft Entra authentication.
Section Field Description
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.
Listener Port The TCP/IP address of the port on which your database communicates with the Database Agent.
Custom JDBC Connection String

The JDBC connection string generated by the database agent, for example, dbc:postgresql://. You can also specify a custom connection string, which is useful for setting custom authentication options.
Database Credentials 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 PostgreSQL.
Password (Optional): The password of the user who is connecting to and monitoring the database through the Database Agent.
Note: If you specify the Microsoft Entra ID username but leave the Password field empty, authentication will be performed using Microsoft Entra ID. See Microsoft Entra ID Authentication for PostgreSQL.
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 website. Then, you must copy the JAR file to the lib directory of the database agent zip file.
HashiCorp Vault See Configure the HashiCorp Vault.
Advanced Options Sub-Collectors

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.

Note:
  • All connection parameters other than the hostname or IP address, and port details of the sub-collector are the same as the main collector. If you want to specify different parameters for the sub–collectors, while creating or editing the collector configuration, you can do that only via the Create Collector API.
  • You cannot convert a custom cluster collector to a standalone collector. If you want to monitor a standalone database, delete the entire custom cluster collector and create a fresh standalone collector. However, note that deleting the custom cluster collector will delete all its historical data.
Connection Properties

Click to add a new JDBC connection property or edit an existing property for relational databases.
EnterpriseDB Click if your PostrgreSQL database installation is an EnterpriseDB distribution.
Exclude Databases The databases that you want to exclude, separated by commas.
Monitor Operating Systems See Configure the Database Agent to Monitor Server Hardware.

Microsoft Entra ID Authentication for PostgreSQL

Database Agent supports Microsoft Entra ID authentication to connect to Azure Database for PostgreSQL. When the Password field is left blank in the Database Credentials configuration, Entra ID becomes the default authentication method. The agent periodically fetches the required access token from the token manager to maintain authentication.

For Microsoft Entra ID authentication to work, ensure the following:

  • Azure Account: The Database Agent or the system where the Database Agent is running must be associated to an Azure account.
  • Microsoft Entra Configuration: Microsoft Entra must be set up so that the Database Agent can retrieve access tokens from the resource URL https://ossrdbms-aad.database.windows.net. See Configure Microsoft Entra Integration.
  • Token Scope: By default, the agent fetches tokens for the Public Azure OSS resource scope. To use a different scope, update the dbagent.azure.entra.scope property in the Database Agent configuration.
Note: If the Database Agent runs outside an Azure virtual machine, additional authentication steps may be required. For example, use the Azure CLI command to ensure that the agent can access the required token:
CODE 
az login
For more information, see Use Microsoft Entra ID for authentication with Azure Database for PostgreSQL.