Manage VM Clusters

Learn how to manage your VM clusters on Oracle Exadata Database Service on Exascale Infrastructure.

Using the Console to Manage VM Clusters on Oracle Exadata Database Service on Exascale Infrastructure

Learn how to use the console to create, edit, and manage your VM Clusters on Oracle Exadata Database Service on Exascale Infrastructure.

Create a VM cluster in an Oracle Exadata Database Service on Exascale Infrastructure instance.

  1. Open the navigation menu. Click Oracle Database, then click Exadata Database Service on Exascale Infrastructure
  2. Click Exadata VM Clusters.
  3. Click Create VM Cluster.

    The Create VM Cluster page is displayed. Provide the required information to configure the VM cluster.

  4. Compartment: Select a compartment for the VM cluster resource.
  5. Display name: Enter a user-friendly display name for the VM cluster. The name doesn't need to be unique. An Oracle Cloud Identifier (OCID) will uniquely identify the DB system. Avoid entering confidential information.
  6. Provide the cluster name: Select the name of the VM cluster.
  7. Select an availability domain: Select the availability domain from the displayed options available.
  8. Configure the VM cluster: Provide the following information:
    • Number of VMs in the cluster: Specify the number of the VMs that you want to configure for the cluster, between 2 and 10.
    • ECPUs enabled per VM: Specify the number of ECPU cores that you want to enable for the VM cluster. The minimum is 8 ECPU. The maximum number of ECPUs is 200 per VM, or limited by the number of total ECPUs you have specified for the VM. The value you select must be a multiple of 4. You can open the reserve additional ECPU section to reserve additional ECPUs.
    • Total ECPUs enabled across cluster per VM: Provide a total number of ECPUs to allocate per VM. The total must be a number between 8 and 200.

  9. (Optional) To reserve additional ECPUs, click Show reserve additional ECPU. Provide the following information:
    • ECPUs additional reserved per VM (read only): Indicates the additional reserved ECPUs. The number of additional ECPUs will be automatically calculated based on the total enabled ECPUs. Additional reserved ECPUs are not active for licensing purposes but are reserved for your VM, and ready and waiting for scaling the Enabled ECPUs.
    • Total ECPUs per VM: Provide a total number of ECPUs to allocate per VM. The total must be a number between 8 and 200.

    • Memory per VM (GB): This is a read-only field. It displays amount of memory allocated to each VM. Memory is calculated based on 11 GB per total cores. The Total memory across VM Cluster (GB) field automatically updates to provide you with the total amount of memory allocated across the VM cluster, based on the memory allocation per VM that you specify.
  10. VM file system storage capacity per VM (GB): Specify storage capacity per VM in gigabytes (GB).

    Provide how much storage you want for all VM file systems together. The VM file systems storage includes /u02 capacity, where your Database Homes will go, along with all of the other VM file systems (/, /boot, /tmp, /var, /var/log, /var/log/audit, /home, swap, kdump, /u01, grid, /u02). Any extra capacity selected beyond system minimums will go into /u02.

    Note

    For information about reserved and enabled cores, and an overview of the ExaDB-XS architecture, see "About Exadata Database Service on Exascale Infrastructure"
  11. Exascale Database Storage Vault: Select either Create new vault or Select existing vault. If you select an existing vault, then select the vault in the compartment. Click Change compartment to select a vault in a different compartment.

    When you create a new vault, the Provisioning status window opens to provide you with the status of vault creation, and the name of the vault that is being created in the format Vault-YYYYMMDDHHMM indicating the creation date, where YYYY is the year, MM is the month, DD is the day, HH is the hour, and MM is the minute.

    Note

    If the vault creation failed, then the Provisioning status window provides you with the work request error message indicating the point where the vault creation operation failed, and the work request ID. Make a note of this work request ID, and open a Service Request with My Oracle Support.
  12. Configure Exascale Database Storage Vault: Select the storage configuration to use for your database's storage. To begin, select whether you want to create a new Vault, or use an existing Vault.

    For a new Vault, specify the following:

    • Storage Vault Name: Name the new Exascale Vault. Optional: Use the link provided to change to another compartment where you want to place the Vault.

    • Enter the Storage Capacity for Databases: The amount of usable disk storage capacity that will be available for storing databases that is desired. Specify the size in gigabytes (GB) between 300 to 100,000.
    • (Optional) Add smart flash as a percentage of storage capacity provisioned (%): Select this option to purchase and specify an additional amount of flash cache over and above the amount of default flash cache that is included in the normal Storage capacity for Databases. Additional flash cache can potentially enable increased performance without adding additional storage capacity in some workloads. Additional flash cache also includes additional memory cache. Specify the additional flash cache as a percentage of the total storage provisioned. If you wish to provision additional flash cache, you must add at least 100 GB of additional flash cache. The amount of smart flash cache in GB that will be added is specified in the read-only field Smart flash cache to be added (GB).

    The minimum size configuration for an Exascale Database Storage Vault is 300 GB. 50 GB of the space that you allocate in your Vault is reserved for a 200 GB ACFS file system. This ACFS file system resides within your Exascale Database Storage Vault, but is reserved for system use. Thus, if you provisioned the minimum of 300 GB in your Exascale Database Storage Vault, then 250 GB of that 300 GB capacity will be available storage for your databases.

  13. Select the Oracle Grid Infrastructure version: This field displays the Oracle Grid Infrastructure versions available for deployment in the VM cluster.
  14. Add SSH key:Add the public key portion of each key pair that you want to use for SSH access to the DB system:
    • Generate SSH key pair (Default option) Select this option to generate an SSH keypair. Then in the dialog below click Save private key to download the key, and optionally click Save public key to download the key.
      Note

      Download the private key so that you can connect to the database system using SSH. It will not be shown again.
    • Upload SSH key files: Select this option to browse or drag and drop .pub files.
    • Paste SSH keys: Select this option to paste in individual public keys.
  15. Configure the network settings: Specify the following:

    • Virtual cloud network: Select the virtual cloud network (VCN) for the compartment in which you want to create the VM cluster. Click Change Compartment to select a VCN in a different compartment.
    • Client subnet: Select the client subnet in the compartment. This is the subnet to which the VM cluster should attach. Click Change Compartment to select a subnet in a different compartment.
      Note

      You must select the VCN before you can select a client subnet.

      Do not use a subnet that overlaps with 192.168.16.16/28, which is used by the Oracle Clusterware private interconnect on the database instance. Specifying an overlapping subnet causes the private interconnect to malfunction.

    • Backup subnet: Select the subnet to use for the backup network, which is typically used to transport backup information to and from the Backup Destination, and for Data Guard replication. Click Change Compartment to select a subnet in a different compartment, if applicable.

      Do not use a subnet that overlaps with 192.168.128.0/20. This restriction applies to both the client subnet and backup subnet.

      Note

      You must select the VCN before you can select a backup client subnet.
    • Use network security groups to control traffic: Optionally, you can specify one or more network security groups (NSGs) for both the client and backup networks. NSGs function as virtual firewalls, allowing you to apply a set of ingress and egress security rules to your Oracle Exadata Database Service on Exascale Infrastructure VM cluster.

      Note that if you choose a subnet with a security list, then the security rules for the VM cluster will be a union of the rules in the security list and the NSGs.

      To use network security groups:

      • Check the Use network security groups to control traffic check box. This box appears under both the selector for the client subnet and the backup subnet. You can apply NSGs to either the client or the backup network, or to both networks. Note that you must have a virtual cloud network selected to be able to assign NSGs to a network.
      • Specify the NSG to use with the network. You might need to use more than one NSG. If you're not sure, contact your network administrator.
    • Hostname prefix Provide your choice of hostname for the Exadata DB system. The host name must begin with an alphabetic character and can contain only alphanumeric characters and hyphens (-). The maximum number of characters allowed for an Exadata DB system is 12.

      Caution:

      The hostname must be unique within the subnet. If it is not unique, then the VM cluster will fail to provision.
    • Host domain name: The domain name for the VM cluster. This is a read-only field. Make a note of the host domain name for your reference.

      If you plan to store database backups in Object Storage or Autonomous Recovery service, Oracle recommends that you use a VCN Resolver for DNS name resolution for the client subnet because it automatically resolves the Swift endpoints used for backups.

    • Host and domain URL This read-only field combines the host and domain names to display the fully qualified domain name (FQDN) for the database. The maximum length is 63 characters.
    Note

    To provide your cloud VM Cluster resources with additional security, you can use Oracle Cloud Infrastructure Zero Trust Packet Routing to ensure that only resources identified with security attributes have network permissions to access your resources. Oracle provides Database policy templates that you can use to assist you with creating policies for common database security use cases. To configure it now, you must already have created security attributes with Oracle Cloud Infrastructure Zero Trust Packet Routing. Click Show Advanced Options at the end of this procedure.

    Be aware that when you provide security attributes for a cluster, as soon as it is applied, all resources require a Zero Trust Packet policy to access the cluster. If there is a security attribute on an endpoint, then it must satisfy both network security group (NSG) and Oracle Cloud Infrastructure Zero Trust Packet Routing policy (OCI ZPR) rules.

  16. Choose a license type: The type of license that you want to use for the VM cluster. Your choice affects metering for billing.

    • License Included means the cost of the cloud service includes a license for the Database service.
    • Bring Your Own License (BYOL) means you are an Oracle Database customer with an Unlimited License Agreement or Non-Unlimited License Agreement, and you want to use your license with Oracle Cloud Infrastructure. This option removes the need for separate on-premises licenses and cloud licenses.
  17. Click Create Exadata VM Cluster.
  18. (Optional) Provide a contact for your VM Cluster. Exadata Database Service on Exascale Infrastructure leverages the OCI Announcements Service. Oracle recommends that you provide your contact details here. Oracle then automatically subscribes you to announcements relevant to this service, including maintenance and outage notifications, among others. If you do not choose to provide a contact now, then you will have to subscribe to announcements manually later, leveraging the OCI Announcements Service directly. To learn more about subscribing, see Subscribing to Announcements.
  19. Click Show Advanced Options to specify advanced options for the VM cluster:

    • Time zone: This option is located in the Management tab. The default time zone for the DB system is UTC, but you can specify a different time zone. The time zone options are those supported in both the Java.util.TimeZone class and the Oracle Linux operating system. For more information, see DB System Time Zone .

      Note

      If you want to set a time zone other than UTC or the browser-detected time zone, and if you do not see the time zone you want, try selecting the Select another time zone, option, then selecting "Miscellaneous" in the Region or country list and searching the additional Time zone selections.

    • SCAN Listener Port: This option is located in the Network tab. You can assign a SCAN listener port (TCP/IP) in the range between 1024 and 8999. The default is 1521
      Note

      Manually changing the SCAN listener port of a VM cluster after provisioning using the backend software is not supported. This change can cause Data Guard provisioning to fail.
      .
    • Zero Trust Packet Routing (ZPR): This option is located in the Security attributes tab. Select a namespace, and provide the key and value for the security attribute. To complete this step during configuration, you must already have set up security attributes with Oracle Cloud Infrastructure Zero Trust Packet Routing. You can also add security attributes after configuration, and add them later.
    • Tags: If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, see Resource Tags. If you are not sure whether to apply tags, skip this option (you can apply tags later) or ask your administrator.

Using the Console to Enable, Partially Enable, or Disable Diagnostics Collection

You can enable, partially enable, or disable diagnostics collection for your Guest VMs after provisioning the VM cluster. Enabling diagnostics collection at the VM cluster level applies the configuration to all the resources such as DB home, Database, and so on under the VM cluster.

Note

  • You are opting in with the understanding that the list of events, metrics, and log files collected can change in the future. You can opt-out of this feature at any time.
  • Oracle may add more metrics in the future, but if you have already chosen to collect metrics, you need not update your opt-in value. It will remain enabled/disabled based on your current preference.
  • If you have previously opted in for incident log and trace file collection and decide to opt out when Oracle Cloud operations run a log collection job, then the job will run its course and will not cancel. Future log collections won't happen until you opt-in again to the incident logs and trace file collection option.
  1. Open the navigation menu. Under Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region that contains your Exadata infrastructure.
  3. Click VM Clusters.
  4. Click the name of the VM cluster you want to enable or disable diagnostic data collection.
  5. On the VM Cluster Details page, under General Information, enable, partially enable, or disable Diagnostics Collection beside Diagnostics Collection.
  6. In the Edit Diagnostics Collection Settings dialog, enable or disable any of the Diagnostics Collections. By enabling diagnostics collection and notifications, Oracle Cloud Operations and you will be able to identify, investigate, track, and resolve guest VM issues quickly and effectively. Subscribe to Events to get notified about resource state changes.
    • Enable Diagnostics Events Allow Oracle to collect and publish critical, warning, error, and information events to me. For more information, see Overview of Database Service Events
    • Enable Health Monitoring Allow Oracle to collect health metrics/events such as Oracle Database up/down, disk space usage, and so on, and share them with Oracle Cloud operations. You will also receive notification of some events.
    • Enable Incident logs and trace collection. Allow Oracle to collect incident logs and traces to enable fault diagnosis and issue resolution.

      Note: You had previously opted in for incident log and trace file collection and decide to opt-out when Oracle Cloud operations run a log collection job, the job will run its course and will not cancel. Future log collections will not run until you opt-in again to the incident logs and trace file collection option.

  7. Select or clear the checkboxes and then click Save Changes.

Using the Console to Update the License Type on a VM Cluster

To modify licensing, be prepared to provide values for the fields required for modifying the licensing information.

  1. Open the navigation menu. Under Oracle Database, click Oracle Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region and Compartment that contains the VM cluster for which you want to update the license type.
  3. Click VM Clusters.
  4. Click the name of the VM cluster for which you want to update the license type.

    The VM Cluster Details page displays information about the selected VM cluster.

  5. Click Update License Type.
  6. In the dialog box, choose one of the following license types and then click Save Changes.
    • Bring Your Own License (BYOL): Select this option if your organization already owns Oracle Database software licenses that you want to use on the VM cluster.
    • License Included: Select this option to subscribe to Oracle Database software licenses as part of Oracle Exadata Database Service on Exascale Infrastructure.

    Updating the license type does not change the functionality or interrupt the operation of the VM cluster.

Increase or decrease the ECPUs, memory or storage available to a VM cluster in Oracle Exadata Database Service on Exascale Infrastructure

Scaling up or down VM cluster resources requires thorough auditing of existing usage and capacity management by the customer DB administrator. Review the existing usage to avoid failures during or after a scale down operation. While scaling up, consider how much of these resources are left for the next VM cluster you are planning to create. Oracle Exadata Database Service on Exascale Infrastructure tooling calculates the current usage of memory, local disk, and ASM storage in the VM cluster, adds headroom to it, and arrives at a minimum value below which you cannot scale down, and expects that you specify the value below this minimum value.

  • You can scale ECPUs enabled per VM. Keep in mind that memory scales with the total ECPU count.
  1. Navigate to the VM Cluster Details page

  2. Click Scale VM Cluster.

    The Configure the VM Cluster window opens, and displays the current configuration of your VM cluster. .

  3. Scale your VM cluster as required:

    • ECPUs enabled per VM: Specify the number of ECPU cores that you want to enable for the VM cluster. The minimum is 8 ECPU. The maximum number of ECPUs is 200 per VM, or limited by the number of total ECPUs you have specified for the VM. The value you select must be a multiple of 4. You can open the reserve additional ECPU section to reserve additional ECPUs.

    • ECPUs additional reserved per VM (read only): Indicates the additional reserved ECPUs. The number of additional ECPUs will be automatically calculated based on the total enabled ECPUs. Additional reserved ECPUs are not active for licensing purposes but are reserved for your VM, and ready and waiting for scaling the Enabled ECPUs.

    • Total ECPUs per VM: Provide a total number of ECPUs to allocate per VM. The total must be a number between 8 and 200.

    • Memory per VM (GB): This is a read-only field. It displays amount of memory allocated to each VM. Memory is calculated based on 11 GB per total cores. The Total memory across VM Cluster (GB) field automatically updates to provide you with the total amount of memory allocated across the VM cluster, based on the memory allocation per VM that you specify.
  4. VM file system storage capacity per VM (GB): Specify storage capacity per VM in gigabytes (GB).

    Provide how much storage you want for all VM filesystems together. The VM Filesystems storage includes /u02 capacity, where your Database Homes will go, along with all of the other VM filesystems (/, /boot, /tmp, /var, /var/log, /var/log/audit, /home, swap, kdump, /u01, grid, /u02). Any extra capacity selected beyond system minimums will go into /u02.

    Note

    For information about reserved and enabled cores, and an overview of the ExaDB-XS architecture, see "About Exadata Database Service on Exascale Infrastructure"

To add SSH keys to a VM cluster

The VM cluster exists, and you wish to add a another user which requires another SSH key.

  1. Open the navigation menu. Click Oracle Database, then click Exadata Database Service on Exascale Infrastructure
  2. Choose your Compartment.
  3. Click Exadata VM Clusters.
  4. In the list of VM clusters, find the cluster you want to manage and click its highlighted name.
  5. Click Add SSH Keys.
  6. Select one of the following options:
    • Generate SSH key pair: Use this option to create a new SSH key pair. Click both Save Private Key and Save Public Key when using this option. The private key is downloaded to your local machine, and should be stored in a safe location. You cannot download another copy of the private key generated during this operation after completing the operation.

    • Upload SSH key files: Select this option to browse or drag and drop .pub files.

    • Paste SSH keys: Select this option to paste in individual public keys. To paste multiple keys, click + Another SSH Key, and supply a single key for each entry.

  7. Click Save Changes.

Using the Console to Add SSH Keys After Creating a VM Cluster

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Exascale Infrastructure.
  2. Click VM Clusters.
  3. Click the name of the VM cluster that you want to add SSH key(s).
  4. In the VM Cluster Details page, click Add SSH Keys.
  5. In the ADD SSH Keys dialog, choose any one of the methods:
    • Generate SSH key pair: Select this option if you want the Control Plane to generate public/private key pairs for you.

      Click Save Private Key and Save Public Key to download and save SSH Key pair.

    • Upload SSH key files: Select this option to upload the file that contains SSH Key pair.
    • Paste SSH keys: Select this option to paste the SSH key string.

      To provide multiple keys, click Another SSH Key. For pasted keys, ensure that each key is on a single, continuous line. The length of the combined keys cannot exceed 10,000 characters.

  6. Click Save Changes.

Using the Console to Stop, Start, or Reboot a VM Cluster Virtual Machine

Use the console to stop, start, or reboot a virtual machine.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region and Compartment that is associated with the VM cluster that contains the virtual machine that you want to stop, start, or reboot.
  3. Click VM Clusters.
  4. Click the name of the VM cluster that contains the virtual machine that you want to stop, start, or reboot.

    The VM Cluster Details page displays information about the selected VM cluster.

  5. In the Resources list, click Virtual Machines.

    The list of virtual machines is displayed.

  6. In the list of nodes, click the Actions icon (three dots) for a node, and then click one of the following actions:
    1. Start: Restarts a stopped node. After the node is restarted, the Stop action is enabled.
    2. Stop: Shuts down the node. After the node is stopped, the Start action is enabled.
    3. Reboot: Shuts down the node, and then restarts it.

Using the Console to Check the Status of a VM Cluster Virtual Machine

Review the health status of a VM cluster virtual machine.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region and Compartment that is associated with the VM cluster that contains the virtual machine that you are interested in.
  3. Click VM Clusters.
  4. Click the name of the VM cluster that contains the virtual machine that you are interested in.

    The VM Cluster Details page displays information about the selected VM cluster.

  5. In the Resources list, click Virtual Machines.

    The list of virtual machines displays. For each virtual machine in the VM cluster, the name, state, and client IP address are displayed.

  6. In the node list, find the virtual machine that you are interested in and check its state.

    The color of the icon and the associated text it indicates its status.

    • Available: Green icon. The node is operational.
    • Starting: Yellow icon. The node is starting because of a start or reboot action in the Console or API.
    • Stopping: Yellow icon. The node is stopping because of a stop or reboot action in the Console or API.
    • Stopped: Yellow icon. The node is stopped.
    • Failed: Red icon. An error condition prevents the continued operation of the virtual machine.

Using the Console to Move a VM Cluster to Another Compartment

To change the compartment that contains your VM cluster on Oracle Exadata Database Service on Exascale Infrastructure, use this procedure.

When you move a VM cluster, the compartment change is also applied to the virtual machines and databases that are associated with the VM cluster. However, the compartment change does not affect any other associated resources, such as the Exadata infrastructure, which remains in its current compartment.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region and Compartment that contains the VM cluster that you want to move.
  3. Click VM Clusters.
  4. Click the name of the VM cluster that you want to move.

    The VM Cluster Details page displays information about the selected VM cluster.

  5. Click Move Resource.
  6. In the resulting dialog, choose the new compartment for the VM cluster, and click Move Resource.

To change the VM cluster display name

Using the Console to Terminate a VM Cluster

Before you can terminate a VM cluster, you must first terminate the databases that it contains.

Terminating a VM cluster removes it from the Cloud Control Plane. In the process, the virtual machines and their contents are destroyed.
  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region and Compartment that contains the VM cluster that you want to terminate.
  3. Click VM Clusters.
  4. Click the name of the VM cluster that you want to terminate.

    The VM Cluster Details page displays information about the selected VM cluster.

  5. Click More Actions, and then click Terminate.
  6. In the resulting dialog:
    • Review the message about the backup retention policy
    • Enter the name of the VM cluster
    • Click Terminate VM Cluster to confirm the action.
    Note

    The database stays in a terminated state with backups listed until all backups are expired.

    The Exascale Vault that had been associated with the VM Cluster survives the deletion of the VM Cluster. This is because Exascale Vaults can be shared among multiple VM Clusters. If the VM Cluster you've terminated was the only one using the VM Cluster, then you should also terminate the Exascale Vault to stop billing related to the Database Storage. See Managing Exascale Database Storage Vaults for more information.

To view details about private DNS configuration

  1. Open the navigation menu. Under Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region that contains your Exadata infrastructure.
  3. Choose the Compartment that contains your Exadata infrastructure.
  4. Click VM Clusters.
  5. Click the name of the VM cluster that is configured with a private DNS you want to view.
  6. Under the Network section, Private DNS and Private Zone are displayed, if a private DNS is configured.
  7. Click the Private View name to edit the configuration.

Adding or Removing a VM From a VM Cluster

You can scale VM Clusters horizontally by adding or removing VMs to or from an existing VM Cluster.

Add a VM to a VM Cluster

Add a Virtual Machine to a VM Cluster

Note

  • This operation is only available with Multi-VM enabled Infrastructure.
  • To add a VM to a VM Cluster requires that all TCP ports are open for the client subnet CIDR for ingress and egress.
  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region and Compartment that contains the VM cluster that you want to scale.
  3. Click VM Clusters.
  4. Click the name of the VM cluster to which you want to add a virtual machine.
  5. Under Resources, select Virtual Machines, and click the Add Virtual Machines button.
  6. In the Add Virual Machines window, select the DB server where you want the new VM to reside.
    Note

    The VM that is added will have the same resources as the other VMs in the cluster.
  7. Click Add Virtual Machine.
Note

Add a VM to a VM Cluster is NOT supported using Terraform.

Terminate a VM from a VM Cluster

To remove a virtual machine from a provisioned cluster, use this procedure.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Exascale Infrastructure.
  2. Choose the Region and Compartment that contains the VM cluster that you want to scale.
  3. Click VM Clusters.
  4. Click the name of the VM cluster for which you want to remove a virtual machine.
  5. On the Exadata VM Cluster Details page, in the Virtual Machines section, select the Virtual Machine that will be removed, click the more commands symbol (three dots) and click Terminate
Note

Remove a VM from a VM Cluster is not supported using Terraform at this time.

Overview of Automatic Diagnostic Collection

By enabling diagnostics collection and notifications, Oracle Cloud Operations and you will be able to identify, investigate, track, and resolve guest VM issues quickly and effectively. Subscribe to Events to get notified about resource state changes.

  • Enable Diagnostic Events

    Allow Oracle to collect and publish critical, warning, error, and information events to you. For more information, see Database Service Events.

  • Enable Health Monitoring

    Allow Oracle to collect health metrics/events such as Oracle Database up/down, disk space usage, and so on, and share them with Oracle Cloud operations. You will also receive notification of some events. For more information, see Health Metrics.

  • Enable Incident Logs and Trace Collection

    Allow Oracle to collect incident logs and traces to enable fault diagnosis and issue resolution. For more information, see Incident Logs and Trace Files.

Diagnostics Collection is:

  • Enabled: When you choose to collect diagnostics, health metrics, incident logs, and trace files (all three options).
  • Disabled: When you choose not to collect diagnostics, health metrics, incident logs, and trace files (all three options).
  • Partially Enabled: When you choose to collect diagnostics, health metrics, incident logs, and trace files (one or two options).

Disabling diagnostic events and health monitoring will only stop the collection and notification of data/events from the time you uncheck the checkboxes tied to the options. However, historical data will not be purged from Oracle Cloud Operations data repositories.

Incident Logs and Trace Files

This section lists all of the files that can be collected by Oracle Support if you opt-in for incident logs and trace collection.

Note

  • Oracle will create a service request (SR) against the infrastructure Customer Support Identifier (CSI) when an issue is detected and needs customer interaction to resolve.
  • The customer's Oralce Cloud Infrastructure tenancy admin email will be used as the CSI contact to create SR and attach logs to it. Ensure tenancy admin is added as a CSI contact in My Oracle Support (MOS).

Oracle Trace File Analyze (TFA) Component Driven Logs Collections

The directories are generally assigned to a component and that component can then be used to guide TFA to the files it needs to collect, for example, requesting the CRS component would tell TFA to look at directories mapped to the CRS component and find files that match the required collection time frame.

Note

If have previously opted in for incident log and trace file collection and decide to opt out when Oracle Cloud operations run a log collection job, then the job will run its course and will not cancel. Future log collections won't happen until you opt-in again to the incident logs and trace file collection option.

TFA is shipped with scripts that run when a particular component is requested, for example, for CRS component, crscollect.pl will run a number of crsctl commands and gather the input. By default, TFA does not redact collected logs.

Table 5-1 Oracle Trace File Analyze (TFA) Component Driven Logs Collections

Component Script Files/Directories

OS: Operating system logs

oscollect.pl

  • /var/log/messages
  • OSWatcher archive
  • Exadata Only: ExaWatcher archive

    /opt/oracle.ExaWatcher/archive/

CRS: Grid Infrastructure and cluster logs

crscollect.pl

  • /etc/oracle
  • GIHOME/crf/db/HOSTNAME1
  • GIHOME/crs/log
  • GIHOME/css/log
  • GIHOME/cv/log
  • GIHOME/evm/admin/log
  • GIHOME/evm/admin/logger
  • GIHOME/evm/log
  • GIHOME/log/-/client
  • GIHOME/log/HOSTNAME1
  • GIHOME/log/HOSTNAME1/admin
  • GIHOME/log/HOSTNAME1/client
  • GIHOME/log/HOSTNAME1/crflogd
  • GIHOME/log/HOSTNAME1/crfmond
  • GIHOME/log/HOSTNAME1/crsd
  • GIHOME/log/HOSTNAME1/cssd
  • GIHOME/log/HOSTNAME1/ctssd
  • GIHOME/log/HOSTNAME1/diskmon
  • GIHOME/log/HOSTNAME1/evmd
  • GIHOME/log/HOSTNAME1/gipcd
  • GIHOME/log/HOSTNAME1/gnsd
  • GIHOME/log/HOSTNAME1/gpnpd
  • GIHOME/log/HOSTNAME1/mdnsd
  • GIHOME/log/HOSTNAME1/ohasd
  • GIHOME/log/HOSTNAME1/racg
  • GIHOME/log/HOSTNAME1/srvm
  • GIHOME/log/HOSTNAME1/xag
  • GIHOME/log/diag/asmtool
  • GIHOME/log/diag/clients
  • GIHOME/log/procwatcher/PRW_SYS_HOSTNAME1
  • GIHOME/network/log
  • GIHOME/opmn/logs
  • GIHOME/racg/log
  • GIHOME/scheduler/log
  • GIHOME/srvm/log
  • GRIDBASE/crsdata/@global/cvu
  • GRIDBASE/crsdata/HOSTNAME1/core
  • GRIDBASE/crsdata/HOSTNAME1/crsconfig
  • GRIDBASE/crsdata/HOSTNAME1/crsdiag
  • GRIDBASE/crsdata/HOSTNAME1/cvu
  • GRIDBASE/crsdata/HOSTNAME1/evm
  • GRIDBASE/crsdata/HOSTNAME1/output
  • GRIDBASE/crsdata/HOSTNAME1/ovmmwallets
  • GRIDBASE/crsdata/HOSTNAME1/scripts
  • GRIDBASE/crsdata/HOSTNAME1/trace
  • GRIDBASE/diag/crs/-/crs/cdump
  • GRIDBASE/diag/crs/HOSTNAME1/crs/cdump
  • GRIDBASE/diag/crs/HOSTNAME1/crs/incident
  • GRIDBASE/diag/crs/HOSTNAME1/crs/trace

Database: Oracle Database logs

No DB Specific Script - runs opatch lsinventory for the ORACLE_HOME the DB runs from TFA will run ipspack based on the time range for certain DB incidents.

  • ORACLE_BASE/diag/rdbms/<dbname>/<instance_name>/cdump
  • ORACLE_BASE/diag/rdbms/<dbname>/<instance_name>/trace
  • ORACLE_BASE/diag/rdbms/<dbname>/<instance_name>/incident

Cloud Tool Logs

  • Creg files: /var/opt/oracle/creg/*.ini files with masked sensitive info
  • Cstate file: /var/opt/oracle/cstate.xml
  • Database related tooling logs:

    If dbName specified, /var/opt/oracle/log/<dbName>, else collect logs for all databases /var/opt/oracle/log/

    If dbName specified, /var/opt/oracle/dbaas_acfs/log/<dbName>, else collect logs for all databases /var/opt/oracle/log/<dbName>

  • Database env files: If dbName specified, /home/oracle/<dbName>.env, else collect logs for all databases /home/oracle/*.env
  • Pilot logs: /home/opc/.pilotBase/logs
  • List of log directories:
    • /var/opt/oracle/log
    • /var/opt/oracle/dbaas_acfs/log
    • /var/opt/oracle/dbaas_acfs/dbsystem_details
    • /var/opt/oracle/dbaas_acfs/job_manager
    • /opt/oracle/dcs/log

DCS Agent Logs

  • /opt/oracle/dcs/log/

Tooling-Related Grid Infrastructure/Database Logs

  • Grid Infrastructure: GI_HOME/cfgtoollogs
  • Database alertlog: /u02/app/oracle/diag/rdbms/*/*/alert*.log

Health Metrics

Review the list of database and non-database health metrics collected by Oracle Trace File Analyzer.

Note

Oracle may add more metrics in the future, but if you have already chosen to collect metrics, you need not update your opt-in value. It will remain enabled/disabled based on your current preference.

Guest VM Health Metrics List - Database Metrics

Table 5-2 Guest VM Health Metrics List - Database Metrics

Metric Name Metric Display Name Unit Aggregation Interval Collection Frequency Description

CpuUtilization

CPU Utilization

Percentage

Mean

One minute

Five minutes

The CPU utilization is expressed as a percentage, which is aggregated across all consumer groups. The utilization percentage is reported with respect to the number of CPUs the database is allowed to use, which is two times the number of ECPUs.

StorageUtilization

Storage Utilization

Percentage

Mean

One hour

One hout

The percentage of provisioned storage capacity currently in use. Represents the total allocated space for all tablespaces.

BlockChanges

DB Block Changes

Changes per second

Mean

One minute

Five minutes

The Average number of blocks changed per second.

ExecuteCount

Execute Count

Count

Sum

One minute

Five minutes

The number of user and recursive calls that executed SQL statements during the selected interval.

CurrentLogons

Current Logons

Count

Sum

One minute

Five minutes

The number of successful logons during the selected interval.

TransactionCount

Transaction Count

Count

Sum

One minute

Five minutes

The combined number of user commits and user rollbacks during the selected interval.

UserCalls

User Calls

Count

Sum

One minute

Five minutes

The combined number of logons, parses, and execute calls during the selected interval.

ParseCount

Parse Count

Count

Sum

One minute

Five minutes

The number of hard and soft parses during the selected interval.

StorageUsed

Storage Space Used

GB

Max

One hour

One hour

Total amount of storage space used by the database at the collection time.

StorageAllocated

Storage Space Allocated

GB

Max

One hour

One hour

Total amount of storage space allocated to the database at the collection time.

StorageUsedByTablespace

Storage Space Used By Tablespace

GB

Max

One hour

One hour

Total amount of storage space used by tablespace at the collection time. In the case of container databases, this metric provides root container tablespaces.

StorageAllocatedByTablespace

Allocated Storage Space By Tablespace

GB

Max

One hour

One hour

Total amount of storage space allocated to the tablespace at the collection time. In the case of container databases, this metric provides root container tablespaces.

StorageUtilizationByTablespace

Storage Space Utilization By Tablespace

Percentage

Mean

One hour

One hour

This indicates the percentage of storage space utilized by the tablespace at the collection time. In the case of container databases, this metric provides root container tablespaces.

Guest VM Health Metrics List - Non-Database Metrics

Table 5-3 Guest VM Health Metrics List - Non-Database Metrics

Metric Name Metric Display Name Unit Aggregation Collection Frequency Description

FilesystemUtilization

Filesystem Utilization

Percentage

Max

One minute

Percent utilization of provisioned filesystem.

CpuUtilization

CPU Utilization

Percentage

Mean

One minute

Percent CPU utilization.

MemoryUtilization

Memory Utilization

Percentage

Mean

One minute

Percentage of memory available for starting new applications, without swapping. The available memory can be obtained via the following command: cat /proc/meminfo.

SwapUtilization

Swap Utilization

Percentage

Mean

One minute

Percent utilization of total swap space.

LoadAverage

Load Average

Number

Mean

One minute

System load average over 5 minutes.

NodeStatus

Node Status

Integer

Mean

One minute

Indicates whether the host is reachable.

Using the API to Manage Oracle Exadata Database Service on Exascale Infrastructure Instance

Use these API operations to manage Exadata Cloud Infrastructure virtual machines (VMs) and databases on Oracle Exadata Database Service on Exascale Infrastructure (ExaDB-XS).

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 manage Oracle Exadata Database Service on Exascale Infrastructure instance components.