Oracle Cloud Infrastructure Documentation

Enable Diagnostics & Management for External Databases

Before you enable Database Management Diagnostics & Management for External Databases, you must:

To enable Diagnostics & Management for External Databases in Database Management:

  1. Sign in to the Oracle Cloud Infrastructure console.
  2. At the top of the page, ensure that the region in which you want to enable Diagnostics & Management is selected.
    Note

    Cross-region monitoring and management of Oracle Databases is not available.
  3. Open the navigation menu, click Observability & Management. Under Database Management, click Administration.
  4. Ensure that the correct compartment is selected in the Compartment applied filter.
  5. Optionally, filter the list to show External Databases. Click inside the Search by database display name field, select Deployment type, select External, and then click Apply filter.

    When this filter is applied, the External Databases in the selected compartment are listed on the Managed databases page. These databases could have been registered either in the Oracle Cloud Infrastructure External Database service or in Database Management.

    Note

    On the Managed databases page, in addition to enabling Database Management features for External Databases, you can also perform the following tasks:
    • Click Actions and then click Register external database to register an External Database. For information, see Create a Handle for an External Database.
    • Click the Actions icon (Actions) for a disconnected External Database, and then click Connect to add a connection. The option to add a connection to an External Database in the Database Management interface is slightly different from the panel in the External Database service. For information, see Add a Connection.
    • Click Actions, click Discover Database System, and then select External Database System to discover External Database Systems. For more information, see Access Database Management Administration.
    • Click Actions, click Discover Exadata Infrastructure, and then select Exadata Infrastructure to discover Exadata Infrastructure resources. For more information, see Access Database Management Administration.
  6. Click Enable Diagnostics & Management.
  7. In the Enable Diagnostics & Management panel:
    1. In the Telemetry section, select OCI Management Agent.
    2. In the Services section, ensure that Database Management is selected. Optionally, select Ops Insights to enable it for the External Database.
      Note

      • If a service is already enabled for the selected database, its enablement request is skipped.
      • Ops Insights does not support External CDBs. If you select a CDB, Ops Insights is skipped and Diagnostics & Management is still enabled. Ops Insights can be enabled for External PDBs and Non-CDB databases.
      • If you select Ops Insights, data from newly enabled resources may take up to 24 hours to appear in Ops Insights.
    3. In the Compartment drop-down list, select the compartment that contains the External Database.
    4. In the External Databases section, select the connected External Database for which you want to enable Diagnostics & Management.
      Note

      • Only connected External Databases can be selected for enablement. If the External Database is not listed, click Register external database to register it. For information, see Create a Handle for an External Database.
      • If an External Database is not connected, click the Actions icon (Actions) and click Connect. After the connection is active, select the External Database. For information, see Add a Connection.
      • If you're enabling Diagnostics & Management for a PDB, you must first enable it for the associated CDB.
      • If you're enabling Diagnostics & Management for a database in an Oracle Data Guard configuration that contains a physical standby database in mounted state, you must ensure that the connector is created by a monitoring user with the SYSDG privilege. If the SYSDG privilege is not granted to the monitoring user, metric collection may stop for the new standby databases following a role switchover or failover.
    5. In the Diagnostics & Management licensing options section, select the applicable licensing option.
      Note

      • The Bring Your Own License (BYOL) subscription does not apply to the Oracle Database Standard Edition. For information on the BYOL subscription, see About Bring Your Own License Subscriptions.
      • If you're enabling Diagnostics & Management for a PDB, then you do not have to select a license option as it's inherited from the associated CDB.
    6. Click Enable Diagnostics & Management.

      The Add databases progress panel is displayed. The status of each selected service is displayed separately. Review the status and any associated error messages.

      Note

      Keep the panel open until enablement completes for all selected services. If you close it before a service starts, that service will not be enabled. Services already in progress continue. To enable a service that did not start, repeat this procedure and select the same database.
    7. Click Close to return to the Managed databases page.

On the Managed databases page, Enabled is displayed in the Diagnostics & Management column after Diagnostics & Management is successfully enabled. Click the Actions icon (Actions) for an External Database, and then click View details to go to the Managed database details page and begin using Diagnostics & Management features.

To disable Diagnostics & Management for an External Database, on the Managed databases page, click the Actions icon (Actions) for the External Database, and then click View features. In the Features supported on <database name> database panel, click Disable in the Diagnostics & Management section.

Add a Connection

You can add a connection to enable Database Management Diagnostics & Management for External Databases.

You can add a connection to a disconnected External Database from the Managed databases page or while enabling Diagnostics & Management. Click the Actions icon (Actions) for the External Database, and then click Connect.

In the Add connection panel:
  1. Provide basic information for the connection:
    1. Connector display name: Optionally, edit the default name assigned to the connector to help you easily identify the resource.
    2. Agent: Select the compartment that contains the Management Agent from the Select agent compartment drop-down list, and then select the Management Agent from the Select agent drop-down list.
  2. Specify connection string information:
    1. DNS hostname or SCAN name: Enter the fully-qualified domain name (FQDN) or IP address for a single instance External Database or the FQDN of the Single Client Access Name (SCAN) listener or the SCAN virtual IP address for a RAC External Database.
    2. Port: Enter the port number.
    3. Service: Enter the service name of the External Database.
    4. Protocol: Select either the TCP or TCPS protocol to connect to the External Database.
    5. TLS secret: Select the TLS secret compartment that contains the secret, and then select the TLS secret. These fields are displayed only if TCPS is selected in the Protocol field. For information on how to create a TLS secret in the Vault service, see Create a Connection to an External Database.
  3. Enter the credentials for the database monitoring user:
    1. User name: Enter the user name.
    2. Password: Select the compartment that contains the database user password secret from the Select password secret compartment drop-down list, and then select the secret from the Select password secret drop-down list.
    3. Role: Select the role from the available options.

    For information on the SQL script to create a monitoring user, see Creating the Oracle Database Monitoring Credentials for Database Management (KB2933173) in My Oracle Support.

  4. Optionally, click Add tag to add free-form or defined tags. If you have permissions to create a resource, then you also have permissions to add free-form tags to that resource. To add a defined tag, you must have permissions to use the tag namespace.

    For information on:

  5. Click Add connection.