Documentation forDatabase Performance Analyzer

Register multiple database instances

If you are monitoring a large number of database instances, use the DPA mass registration feature to quickly register multiple databases.

For DPA to collect metrics from a monitored SQL Server instance, Azure SQL instance, or ASMI, the SQL option NUMERIC_ROUNDABOUT must be set to OFF.

Complete the following steps to download a predefined template and enter the required information for all database instances.

  1. From the DPA menu in the upper-right corner, click Options.

  2. Under Monitor Setup > Database Instances, click Mass registration.

  3. Specify whether you want to edit and save the template on the DPA server or on your local computer.

    The instructions displayed in the right pane reflect your selection.

  4. Under How to, click the link in step 1 to download the registration template used for all database types.

  5. Edit the file to add information about each database instance.

    Do not edit the header row.

    • If you are registering multiple nodes in an Oracle RAC, manually create the monitoring user before you run mass registration. Enter N in the Create Monitoring User column of the template, and specify the manually created user for all nodes in the RAC.

    • For an Azure SQL Managed Instance (ASMI), manually create the DPA monitoring user before you run mass registration, and enter N in the Create Monitoring User column.

    • For PostgreSQL, manually create the DPA monitoring user before you run mass registration, and enter N in the Create Monitoring User column.

      You must also configure the database instances for monitoring before you run mass registration.

    • To authenticate the monitoring user with a group managed service account (gMSA):

      • Leave the Monitoring User and Monitoring User Password columns blank.

      • Enter N in the Create Monitoring User column.

      • Enter Y in the Windows Authentication column.

    Column DB instances Description
    Database Type All

    Enter one of the following values:

    • SQL Server
    • Oracle
    • MySQL
    • MariaDB
    • Db2
    • Sybase
    • Azure SQL Database
    • Azure SQL Managed Instance
    • PostgreSQL
    Display Name All (Optional) Enter a display name to identify this database instance within DPA, or leave this field blank to use the default. You can change the display name later.
    Server All

    Enter the server host name or IP address.

    • For SQL Server, if the SQL Server Browser service is running, enter the server name or IP address and the instance name in this format: Server\Instance.
    • For an Azure SQL database, enter the logical server name.
    Port All

    If the default port is not used, specify the port that DPA should use to connect to the database instance. The default ports are:

    • SQL Server, Azure SQL database, or Azure SQL Managed Instance: 1433
    • Oracle: 1521
    • MySQL: 3306
    • PostgreSQL: 5432
    • Sybase: 5000
    • Db2: 50000
    Service Name Oracle Specify the Service name of the database instance. If you complete this column, leave the SID column blank.
    SID Oracle Specify the SID (System Identifier) of the database instance. If you complete this column, leave the Service Name column blank.
    Database Azure SQL Database, PostgreSQL, and Db2

    For Azure SQL database, enter the name of the database.

    For PostgreSQL or Db2, enter the name of a database in the instance. The specified database is used during registration. DPA monitors all databases in the instance.

    Privileged User All except Db2, PostgreSQL, and ASMI

    (Optional) If you complete this field, during registration DPA uses the credentials of the privileged user to either create or configure the monitoring user. (The monitoring user enables DPA to collect information from the monitored instance.) DPA does not store the credentials of the privileged user.

    • If you want DPA to create or configure the monitoring user, enter the name of a user with the required privileges:

      • Oracle: The DBA role
      • SQL Server: The SYSADMIN role
      • Sybase: The sa_role and the sso_role
      • MySQL: The privileges listed here
      • Azure SQL Database: The db_owner role

    • If you do not want to provide the credentials of a privileged user, or if DPA is integrated with CyberArk, leave this field blank and create the monitoring user yourself. See the instructions in the wizard topic for each database type.
    Privileged User Password All except Db2, PostgreSQL, and ASMI (Optional) If you specified a privileged user, enter the password of the privileged user.
    Monitoring User All, if not integrated with CyberArk or using a gMSA

    Enter the name of the monitoring user that you created, or the name of the user that DPA will create during registration.

    If CyberArk is enabled, leave this column empty.

    If a gMSA is used for authentication, leave this column empty. Any value will be ignored.

    For Azure SQL Database and ASMI database instances specifying a service principal instead of a user account, enter the service principal application ID.

    Monitoring User Password All, if not integrated with CyberArk or using a gMSA

    Enter the password for the monitoring user that you created, or the password for the user that DPA will create during registration.

    If CyberArk is enabled, leave this column empty.

    If a gMSA is used for authentication, leave this column empty. Any value will be ignored.

    For Azure SQL Database and ASMI database instances specifying a service principal instead of a user account, enter the value of the service principal secret.

    Create Monitoring User (Y/N) All

    If DPA will create a new user during registration, enter Y.

    If you created the monitoring user, you are using gMSA, or if DPA will configure an existing user during registration, enter N.
    Deployment SQL Server, Oracle, MySQL, and PostgreSQL

    If the instance runs in a self-managed environment, you can leave this column blank or enter On-prem. (On-prem is the default value.)

    If the instance is deployed in the cloud, enter one of the following values:

    • Amazon – The instance runs in Amazon RDS
    • Azure – The instance runs in Microsoft Azure
    • Google – The instance runs in the Google Cloud Platform
    Repository Tablespace DPA deployments with an Oracle repository

    (Optional) If your repository database is Oracle, specify which tablespace in the repository database is used to store DPA performance data for this monitored instance.

    By default, performance data is stored in the default tablespace of the repository user. However, data for monitored instances can be stored in separate tablespaces.
    Domain SQL Server with NTLM

    If the instance uses NTLM authentication, specify the domain of the monitoring user.
    Windows Authentication (Y/N) SQL Server

    If the monitoring user is a Windows user with the syntax DOMAIN\username, enter Y. The default value is N.

    If this column contains Y, then the Create Monitoring User (Y/N) column must contain N. DPA cannot create a Windows user.
    SYS Password Oracle

    DPA requires a utility package to monitor Oracle database instances, and the monitoring user must have execute permissions for that package. DPA can create the utility package, or you can run a script to create it:

    • If you want DPA to create the utility package, enter the SYS password in this column.

      DPA does not store the SYS password. It is used only during registration and then forgotten.

    • If you prefer not to provide the SYS password, leave this column blank, and run a script to create the monitoring user and the utility package. For instructions, see Task 1: Create the monitoring user and utility package.

      If this column is blank, then the Create Monitoring User (Y/N) column must contain N. The script creates the monitoring user and gives it and execute permissions for the utility package .

    Monitoring User Tablespace Oracle Specify a tablespace on the monitored database instance that is available for use by the monitoring user. DPA uses less than 5 MB of space.
    Monitoring User Temp Tablespace Oracle Specify a temporary tablespace on the monitored database instance that is available for use by the monitoring user.
    SSL mode PostgreSQL, SQL Server, Oracle, and Sybase

    Enter one of the following values to specify the type of secure socket layer (SSL) connections established between the instance and the DPA server:

    • disable – SSL encryption is not used.

    • require – SSL is enabled, but no server certificate checks are performed. The server is trusted by default. Not supported for Oracle.

    • verify-ca – SSL is enabled. The client verifies that the server is trustworthy by checking the certificate chain up to a trusted certificate authority (CA).

    • verify-full – SSL is enabled. The client verifies the certificate chain and also verifies that the server hostname matches its certificate's Subject Alternative Name or Common Name (CN).
    E-Business Suite (Y/N) Oracle

    Enter Y if the monitored instance contains the Oracle E-Business Suite and you want DPA to collect additional information about the suite. DPA can capture Oracle E-Business data to identify the screens, modules, and users generating the database requests. This gives you increased visibility into the causes of performance problems.

    The default value is N.
    Additional JDBC URL Properties All (Optional) If additional JDBC URL properties are needed to enable DPA to connect to the monitored instance, enter them as name/value pairs delimited by semicolons (for example, Property1=Value;Property2=Value).
    Additional Connection Properties All (Optional) If additional connection properties are needed to enable DPA to connect to the monitored instance, enter them as name/value pairs delimited by semicolons (for example, Property1=Value;Property2=Value).
    Database Group All

    (Optional) If you want to assign the instance to a group, enter the group name.

    If an AG is registered via the listener, it might not be added to the group due to automatic instance naming.
    CyberArk query All, if integrated with CyberArk If DPA is integrated with CyberArk, enter the query to retrieve the credentials of the monitoring user from CyberArk.
    Is gMSA? (Y/N) SQL Server

    Enter Y to authenticate the monitoring user with a group managed service account (gMSA).
    Authentication Method AzureSQL Database, ASMI

    Enter one of the following values to specify the authentication method used to register the instance:

    • PASSWORD – (Default) A SQL Server user password

    • MEP – A Microsoft Entra (formerly Azure AD) password

    • MESP – A Microsoft Entra service principal (formerly Azure service principal)

    Do not specify the authentication method in the Additional Connection Properties column.

  6. Save the file in .csv format.

    If you selected From DPA server, the file must be saved in the following location:

    <DPA_home>/iwc/tomcat/ignite_config/registration

    The file name must be massreg.csv.

  7. If you selected From local computer, click the Choose File button and select the file you saved.
  8. Click Load Registration File.

If you register a database instance within the 14-day trial period, DPA begins monitoring the instance immediately. After the trial period, you must activate a license to monitor the database instance.