Oracle Cloud Infrastructure Documentation

Updated 2024-06-17

Monitor Metrics to Diagnose and Troubleshoot Problems with Pluggable Databases

Enable Database Management service to view metrics to diagnose and troubleshoot problems with pluggable databases.

Parent topic: Reference Guides for Oracle Exadata Database Service on Exascale Infrastructure

About Database Management

As a Database Administrator, you can use the Oracle Cloud Infrastructure Database Management service to monitor and manage Oracle Databases. For more information, see About Database Management.

Performance Hub provides a visual representation of diagnostic data that you can leverage to fix performance issues or tune the database to improve performance. For more information about Performance Hub, see Performance Hub.

Using the Console to Enable Database Management for a Container Database (CDB)

To enable Database Management for a container database (CDB), use this procedure.

Note

You can also enable Database Management for a database from the Database Management Administration page. For more information, see Enable Database Management for Oracle Cloud Databases.
  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the database for which you want to enable Database Management.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database for which you want to enable Database Management.

    Database Details page is displayed.

  5. In the Database Information section, under the Associated Services, check the status of Database Management.

    If the Database Management is displayed as Not Enabled, perform the following steps:

Enable Database Management

  1. Click Enable.

    Enable Database Management window is displayed.

  2. In the Database information section, provide the following details:
    • Database type: Read-only. Type of the database.
    • Exadata VM Cluster: Read-only. Compartment in which the database is located.
    • Database home: Read-only. Database home of the database.
    • Database name: Read-only. Name of the database.
    • Service name: The unique service name of the database. A default unique name is displayed, which can be changed if required.
    • Protocol: Select either TCP or TCPS to connect to the Oracle Cloud Database. TCP is selected by default.
      Note

      • If Oracle Data Guard is enabled after Database Management was enabled for an Exadata VM Cluster using the TCPS protocol, then TCPS will have to be reconfigured. Enabling Oracle Data Guard is causing TCPS configuration to be overwritten, and it's recommended that TCPS is configured on an Exadata VM Cluster after enabling Oracle Data Guard.
      • Database Management currently does not support Oracle Data Guard configuration and Database Management features are not available for standby databases.
    • Port: Specify the port number.

      If TCP is selected in the Protocol field, then the port number 1521 is displayed by default. You can change it if required. You can select the port number from a range of 1 to 65535.

    • Database wallet secret: This field is only displayed if TCPS is selected in the Protocol field.
      1. Select the secret that contains the database wallet from the drop-down list. If an existing database wallet secret is not available, then select Create new secret... from the drop-down list.

        The Create database wallet secret panel is displayed and you can create a new secret.

        For information on database wallets and creating a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      2. If the Database Management (dpd) service policy that grants Database Management permission to read the secret that contains the database wallet is not created, then the System policies are required... message is displayed. You can click Add policy to view and automatically create the service policy.

        For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  3. In the Specify credentials for the connection section, provide the following details:
    • Database user name: Enter the database user name.
    • Database user password secret:
      1. Select the secret that contains the database user password from the drop-down list. If the compartment in which the secret resides is different from the compartment displayed, then click Change compartment and select another compartment. If an existing secret with the database user password is not available, then select Create new secret... from the drop-down list.

        The Create password secret panel is displayed and you can create a new secret.

        For information on database monitoring user credentials and saving the database user password as a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      2. If the Database Management (dpd) service policy that grants Database Management permission to read the secret that contains the database wallet is not created, then the System policies are required... message is displayed. You can click Add policy to view and automatically create the service policy.

        For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  4. In the Private endpoint information section, select the private endpoint that will act as a representation of Database Management in the VCN in which the Oracle Cloud Database can be accessed.

    You can choose the private endpoint from a different compartment as well. You must ensure that the appropriate Database Management private endpoint is available.

    Here are the two types of Database Management private endpoints:

    • Private endpoint for single instance Databases in the bare metal and virtual machine DB systems.
    • Private endpoint for Oracle RAC Databases in the virtual machine DB system.

    If a Database Management private endpoint is not available, then you must create one.

    For information on how to create a private endpoint, see Create a Database Management Private Endpoint.

  5. In the Management options section, choose between the following options:
    • Full management: This includes fleet management, advanced Performance Hub, and other SKU features along with basic management capabilities.
    • Basic management: This includes basic monitoring metrics and the ASH Analytics and SQL Monitoring features in Performance Hub for container databases.

      For more information on management options, see About Management Options.

  6. Click Enable Database Management.
  7. A confirmation message with a link to the Oracle Cloud Database's Work requests section on the Database information page is displayed. Click the link to monitor the progress of the work request.
  8. In the Database Information section, under the Associated Services, verify if the status of Database Management is Enabled.

    The Disable option is also displayed, which you can click to disable Database Management.

If you encounter issues when enabling Database Management, see Issues Encountered When Enabling Database Management for Oracle Cloud Databases for likely causes and solutions.

Using the Console to Enable Database Management for a Pluggable Database (PDB)

To enable Database Management for a pluggable database (PDB), use this procedure.

Note

You can also enable Database Management for a database from the Database Management Administration page. For more information, see Enable Database Management for Oracle Cloud Databases.

Prerequisite

To enable the Database Management for a pluggable database, enable Database Management for the associated database with the Full Management option.

  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the pluggable database for which you want to enable Database Management.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database that contains the pluggable database for which you want to enable Database Management.

    Database Details page is displayed.

  5. Under Resources, click Pluggable Databases.
  6. In the list of pluggable databases, click the pluggable database for which you want to enable Database Management.

    Pluggable Database Details page is displayed.

  7. In the Database Information section, under the Associated Services, check the status of Database Management.

    If the Database Management is displayed as Not Enabled, perform the following steps:

Enable Database Management

  1. Click Enable.

    Enable Database Management window is displayed.

  2. In the Database information section, provide the following details:
    • Database type: Read-only. Type of the database.
    • Exadata VM Cluster: Read-only. Compartment in which the database is located.
    • Database home: Read-only. Database home of the database.
    • Pluggable Database name: Read-only. Name of the database.
    • Service name: The unique service name of the database. A default unique name is displayed, which can be changed if required.
    • Protocol: Select either TCP or TCPS to connect to the Oracle Cloud Database. TCP is selected by default.
      Note

      • If Oracle Data Guard is enabled after Database Management was enabled for an Exadata VM Cluster using the TCPS protocol, then TCPS will have to be reconfigured. Enabling Oracle Data Guard is causing TCPS configuration to be overwritten, and it's recommended that TCPS is configured on an Exadata VM Cluster after enabling Oracle Data Guard.
      • Database Management currently does not support Oracle Data Guard configuration and Database Management features are not available for standby databases.
    • Port: Specify the port number.

      If TCP is selected in the Protocol field, then the port number 1521 is displayed by default. You can change it if required. You can select the port number from a range of 1 to 65535.

    • Database wallet secret: This field is only displayed if TCPS is selected in the Protocol field.
      1. Select the secret that contains the database wallet from the drop-down list. If an existing database wallet secret is not available, then select Create new secret... from the drop-down list.

        The Create database wallet secret panel is displayed and you can create a new secret.

        For information on database wallets and creating a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      2. If the Database Management (dpd) service policy that grants Database Management permission to read the secret that contains the database wallet is not created, then the System policies are required... message is displayed. You can click Add policy to view and automatically create the service policy.

        For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  3. In the Specify credentials for the connection section, provide the following details:
    • Database user name: Enter the database user name.
    • Database user password secret:
      1. Select the secret that contains the database user password from the drop-down list. If the compartment in which the secret resides is different from the compartment displayed, then click Change compartment and select another compartment. If an existing secret with the database user password is not available, then select Create new secret... from the drop-down list.

        The Create password secret panel is displayed and you can create a new secret.

        For information on database monitoring user credentials and saving the database user password as a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      2. If the Database Management (dpd) service policy that grants Database Management permission to read the secret that contains the database wallet is not created, then the System policies are required... message is displayed. You can click Add policy to view and automatically create the service policy.

        For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  4. In the Private endpoint information section, select the private endpoint that will act as a representation of Database Management in the VCN in which the Oracle Cloud Database can be accessed.

    You can choose the private endpoint from a different compartment as well. You must ensure that the appropriate Database Management private endpoint is available.

    Here are the two types of Database Management private endpoints:

    • Private endpoint for single instance Databases in the bare metal and virtual machine DB systems.
    • Private endpoint for Oracle RAC Databases in the virtual machine DB system.

    If a Database Management private endpoint is not available, then you must create one.

    For information on how to create a private endpoint, see Create a Database Management Private Endpoint.

  5. In the Management options section, choose between the following options:
    • Full management: This includes fleet management, advanced Performance Hub, and other SKU features along with basic management capabilities.
    • Basic management: This includes basic monitoring metrics and the ASH Analytics and SQL Monitoring features in Performance Hub for container databases.

      For more information on management options, see About Management Options.

  6. Click Enable Database Management.
  7. A confirmation message with a link to the Oracle Cloud Database's Work requests section on the Database information page is displayed. Click the link to monitor the progress of the work request.
  8. In the Database Information section, under the Associated Services, verify if the status of Database Management is Enabled.

    The Disable option is also displayed, which you can click to disable Database Management.

If you encounter issues when enabling Database Management, see Issues Encountered When Enabling Database Management for Oracle Cloud Databases for likely causes and solutions.

Using the Console to Edit Database Management for a Pluggable Database (PDB)

To edit the Database Management configuration for a pluggable database (PDB), use this procedure.

Note

You can also enable Database Management for a database from the Database Management Administration page. For more information, see Enable Database Management for Oracle Cloud Databases.

Prerequisite

To enable the Database Management for a pluggable database, enable Database Management for the associated database with the Full Management option.

  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the pluggable database for which you want to edit Database Management.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database that contains the pluggable database for which you want to edit Database Management.

    Database Details page is displayed.

  5. Under Resources, click Pluggable Databases.
  6. In the list of pluggable databases, click the pluggable database for which you want to edit Database Management.

    Pluggable Database Details page is displayed.

  7. In the Database Information section, under the Associated Services, check the status of Database Management.

    If the Database Management is displayed as Enabled, perform the following steps to edit Database Management:

Edit Database Management

  1. Click Enable.

    Edit Database Management window is displayed.

  2. In the Database information section, provide the following details:
    • Database type: Read-only. Type of the database.
    • Exadata VM Cluster: Read-only. Compartment in which the database is located.
    • Database home: Read-only. Database home of the database.
    • Pluggable Database name: Read-only. Name of the database.
    • Service name: The unique service name of the database. A default unique name is displayed, which can be changed if required.
    • Protocol: Select either TCP or TCPS to connect to the Oracle Cloud Database. TCP is selected by default.
      Note

      • If Oracle Data Guard is enabled after Database Management was enabled for an Exadata VM Cluster using the TCPS protocol, then TCPS will have to be reconfigured. Enabling Oracle Data Guard is causing TCPS configuration to be overwritten, and it's recommended that TCPS is configured on an Exadata VM Cluster after enabling Oracle Data Guard.
      • Database Management currently does not support Oracle Data Guard configuration and Database Management features are not available for standby databases.
    • Port: Specify the port number.

      If TCP is selected in the Protocol field, then the port number 1521 is displayed by default. You can change it if required. You can select the port number from a range of 1 to 65535.

    • Database wallet secret: This field is only displayed if TCPS is selected in the Protocol field.
      1. Select the secret that contains the database wallet from the drop-down list. If an existing database wallet secret is not available, then select Create new secret... from the drop-down list.

        The Create database wallet secret panel is displayed and you can create a new secret.

        For information on database wallets and creating a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      2. If the Database Management (dpd) service policy that grants Database Management permission to read the secret that contains the database wallet is not created, then the System policies are required... message is displayed. You can click Add policy to view and automatically create the service policy.

        For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  3. In the Specify credentials for the connection section, provide the following details:
    • Database user name: Enter the database user name.
    • Database user password secret:
      1. Select the secret that contains the database user password from the drop-down list. If the compartment in which the secret resides is different from the compartment displayed, then click Change compartment and select another compartment. If an existing secret with the database user password is not available, then select Create new secret... from the drop-down list.

        The Create password secret panel is displayed and you can create a new secret.

        For information on database monitoring user credentials and saving the database user password as a secret in the Vault service, see Oracle Cloud Database-related Prerequisite Tasks.

      2. If the Database Management (dpd) service policy that grants Database Management permission to read the secret that contains the database wallet is not created, then the System policies are required... message is displayed. You can click Add policy to view and automatically create the service policy.

        For information on Vault service permissions required to use existing secrets or create new secrets, see Permissions Required to Enable Database Management for Oracle Cloud Databases.

  4. In the Private endpoint information section, select the private endpoint that will act as a representation of Database Management in the VCN in which the Oracle Cloud Database can be accessed.

    You can choose the private endpoint from a different compartment as well. You must ensure that the appropriate Database Management private endpoint is available.

    Here are the two types of Database Management private endpoints:

    • Private endpoint for single instance Databases in the bare metal and virtual machine DB systems.
    • Private endpoint for Oracle RAC Databases in the virtual machine DB system.

    If a Database Management private endpoint is not available, then you must create one.

    For information on how to create a private endpoint, see Create a Database Management Private Endpoint.

  5. In the Management options section, choose between the following options:
    • Full management: This includes fleet management, advanced Performance Hub, and other SKU features along with basic management capabilities.
    • Basic management: This includes basic monitoring metrics and the ASH Analytics and SQL Monitoring features in Performance Hub for container databases.

      For more information on management options, see About Management Options.

  6. Click Enable Database Management.
  7. A confirmation message with a link to the Oracle Cloud Database's Work requests section on the Database information page is displayed. Click the link to monitor the progress of the work request.
  8. In the Database Information section, under the Associated Services, verify if the status of Database Management is Enabled.

    The Disable option is also displayed, which you can click to disable Database Management.

If you encounter issues when enabling Database Management, see Issues Encountered When Enabling Database Management for Oracle Cloud Databases for likely causes and solutions.

Using the Console to Disable Database Management for a Pluggable Database (PDB)

To disable Database Management for a pluggable database (PDB), use this procedure.

  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the pluggable database for which you want to disable Database Management.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database that contains the pluggable database for which you want to disable Database Management.

    Database Details page is displayed.

  5. Under Resources, click Pluggable Databases.
  6. In the list of pluggable databases, click the pluggable database for which you want to disable Database Management.

    Pluggable Database Details page is displayed.

  7. In the Database Information section, under the Associated Services, check the status of Database Management.
  8. If the Database Management is displayed as Enabled, perform the following steps to disable Database Management:
    1. Click Disable.
    2. A confirmation message with a link to the Work requests section on the Database information page is displayed. Click the link to monitor the progress of the work request.
    3. In the Database Information section, under the Associated Services, verify if the status of Database Management is Disabled.

Using the Console to View Performance Hub for a Container Database (CDB)

To view Performance Hub for a container database (CDB), use this procedure. You must first enable Database Management to view the performance report.

  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the database for which you want to view Performance Hub.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database for which you want to view Performance Hub.

    Database Details page is displayed.

  5. Click Performance Hub.

With Basic Management, Performance Hub provides ASH Analytics and SQL Monitoring. Advanced Management will additionally provide ADDM, Workload, and Blocking Sessions.

Performance Hub allows you to download reports for your managed databases. For more information about downloading reports, see Automatic Workload Repository (AWR) Report, Active Sessions History (ASH) Report, and Performance Hub Report.

Using the Console to View Performance Hub for a Pluggable Database (PDB)

To view Performance Hub for a pluggable database (PDB), use this procedure. You must first enable Database Management to view the performance report.

  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the pluggable database for which you want to view Performance Hub.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database that contains the pluggable database.

    Database Details page is displayed.

  5. Under Resources, click Pluggable Databases.
  6. In the list of pluggable databases, click the pluggable database that you're interested in.

    Pluggable Database Details page is displayed.

  7. Click Performance Hub.

With Basic Management, Performance Hub provides ASH Analytics and SQL Monitoring. Advanced Management will additionally provide ADDM, Workload, and Blocking Sessions.

Performance Hub allows you to download reports for your managed databases. For more information about downloading reports, see Automatic Workload Repository (AWR) Report, Active Sessions History (ASH) Report, and Performance Hub Report.

Using the API to Enable, Disable, or Update Database Management Service

For information about using the API and signing requests, see REST APIs and Security Credentials. For information about SDKs, see Software Development Kits and Command Line Interface.

Use these API operations to configure the Database Management service.

  • Enable Database Management service for an Oracle Database located in Oracle Cloud Infrastructure to access tools including Metrics and Performance hub: enableDatabaseManagement

  • Disable Database Management service: disableDatabaseManagement
  • Update Database Management configuration: updateDatabaseManagement

Oracle Cloud Database Metrics

Use the metrics to diagnose and troubleshoot issues.

The metrics for Oracle Cloud Databases help measure useful quantitative data, such as CPU and storage utilization, the number of successful and failed database logon and connection attempts, database operations, SQL queries, transactions, and so on.

For more information, see Oracle Cloud Database Metrics.

Related Topics

Parent topic: Monitor Metrics to Diagnose and Troubleshoot Problems with Pluggable Databases

Using the Console View Metrics for a Container Database (CDB)

To view metrics for a container database (CDB), you must first enable Database Management with the Full Management option.

To enable Database Management for databases, see Using the Console to Enable Database Management for a Database.

  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the database for which you want to view the metrics.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database for which you want to view the metrics.

    Database Details page is displayed.

  5. Under Resources, click Metrics.

Using the Console to View Metrics for a Pluggable Database (PDB)

To view metrics for a Pluggable Database (PDB), the following prerequisites must be met:

  • Enable Database Management for databases with the Full Management option.
  • Enable Database Management for pluggable databases.
  1. Open the navigation menu. Click Oracle Database, then click Exadata on Oracle Public Cloud.
  2. Choose your Compartment.

    A list of Exadata VM Clusters is displayed.

  3. In the list of Exadata VM Clusters, click the Exadata VM Cluster that contains the pluggable database for which you want to view the metrics.

    Exadata VM Cluster Details page is displayed.

    Under Resources, Databases is selected by default.

  4. In the list of databases, click the database that contains the pluggable database.

    Database Details page is displayed.

  5. Under Resources, click Pluggable Databases.
  6. In the list of pluggable databases, click the pluggable database for which you want to view the metrics.

    Pluggable Database Details page is displayed.

  7. Under Resources, click Metrics.
  8. Select a namespace from the Metric namespace from where you wish to view metrics.
    Note

    • When Database Management is enabled, then you can view metrics only from the oracle_oci_database namespace.
    • When Database Management is disabled, then a banner, "Database management must be enabled to provide data for metrics." is displayed.

With Basic Management, Performance Hub provides ASH Analytics and SQL Monitoring. Advanced Management will additionally provide ADDM, Workload, and Blocking Sessions.

Updated 2024-06-17