Prerequisites

  • OpsRamp Classic Gateway (Linux) 15.0.0 and above.

  • OpsRamp Nextgen Gateway 15.0.0 and above Note: OpsRamp recommends using the latest Gateway version for full coverage of recent bug fixes, enhancements, etc.

  • For Bash CLI cmdlets the following are prerequisites:

    • SSH User (Prefer - Oracle user) should be able to execute bash commands and listener related commands (like crsctl, srvctl..etc).
  • Users can establish db connection from gateway to oracle scan name and local listeners as well.

Configure Oracle Cluster Integration

  1. To select your client, navigate to All Clients, and click the Client/Partner dropdown menu.
    Note: You may either type your client’s name in the search bar or select your client from the list.
  2. Navigate to Setup > Account. The Account Details screen is displayed.
  3. Click Integrations. The Installed Integrations screen is displayed with all the installed applications.
    Note: If you do not have any installed applications, you will be navigated to the Available Integrations and Apps page with all the available applications along with the newly created application with the version.
  4. Click + ADD on the Installed Integrations page.
    Note: Search for the integration either by entering the name of the integration in the search bar or by selecting the category of the integration from the All Categories dropdown list.
  5. Click ADD in the Oracle Cluster application.
  6. In the Configuration screen, click + ADD. The Add Configuration screen appears.
  7. Enter the following BASIC INFORMATION:
Field NameDescriptionField Type
NameEnter the name for the integration.String
ModeSelect the type of Oracle deployment mode. Choose between RAC (Real Application Cluster) or Standalone.String
Oracle Hostname/ IP AddressEnter the Oracle Hostname/ IP Address of the Oracle Cluster. It should be accessible from Gateway.
Note: If the Mode is RAC scan should be provided, else Hostname/IP Address of the node should be provided.
String
SSH PortSpecify the SSH port for the Oracle server.

Note: By default, 22 is the SSH port value.
Integer
Oracle SSH CredentialsSelect the credential associated with your Oracle Cluster account. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click + Add to create credentials. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Provide additional details or notes about the credential.
  • User Name: Enter the username required for authentication
  • Password: Enter the password associated with the provided username for secure authentication.
  • Confirm Password: Re-enter the password to confirm and ensure it matches the previously entered value.
  • Port: Specify the port used for connecting to the application or service. This is typically required for protocols like SSH or database connections.
  • Connection Timeout (ms): Enter the maximum timeout value (in milliseconds) for establishing a connection to the application or service. This defines how long the system will wait before the connection attempt fails.
Dropdown
Database PortSpecify the port number used for database communication

Note: By default 1521 is the database port value.
Integer
Oracle Database CredentialsSelect the credential associated with your Oracle database account. If you want to use the existing credentials, select them from the Select Credentials dropdown. Else, click + Add to create credentials. The ADD CREDENTIAL window is displayed. Enter the following information.
  • Name: Credential name.
  • Description: Provide additional details or notes about the credential.
  • User Name: Enter the username required for authentication
  • Password: Enter the password associated with the provided username for secure authentication.
  • Confirm Password: Re-enter the password to confirm and ensure it matches the previously entered value.
  • Port: Specify the port used for connecting to the application or service. This is typically required for protocols like SSH or database connections.
  • Connection Timeout (ms): Enter the maximum timeout value (in milliseconds) for establishing a connection to the application or service. This defines how long the system will wait before the connection attempt fails.
Dropdown
Enter the name of the Oracle database instance that needs to be monitored.Database NameInteger
App Failure NotificationsWhen selected, you will be notified in case of an application failure such as Connectivity Exception, Authentication Exception.Checkbox
  1. CUSTOM ATTRIBUTES: Custom attributes are the user-defined data fields or properties that can be added to the preexisting attributes to configure the integration.
Field NameDescriptionField Type
Custom AttributeSelect the custom attribute from the dropdown. You can add attributes by clicking the Add icon (+).Dropdown
ValueSelect the value from the dropdown.Dropdown

Note: The custom attribute that you add here will be assigned to all the resources that are created by the integration. You can add a maximum of five custom attributes (key and value pair).

  1. In the RESOURCE TYPE section, select:
    • ALL: All the existing and future resources will be discovered.
    • SELECT: You can select one or multiple resources to be discovered.
  2. In the DISCOVERY SCHEDULE section, select recurrence pattern to add one of the following patterns:
    • Minutes
    • Hourly
    • Daily
    • Weekly
    • Monthly
  3. Click ADD.

Now the configuration is saved and displayed on the configurations page after you save it.
Note: From the same page, you may Edit and Remove the created configuration.
12. Under the ADVANCED SETTINGS, Select the Bypass Resource Reconciliation option, if you wish to bypass resource reconciliation when encountering the same resources discovered by multiple applications.
Note: If two different applications provide identical discovery attributes, two separate resources will be generated with those respective attributes from the individual discoveries.
13. Click NEXT.
14. (Optional) Click +ADD to create a new collector. You can either use the pre-populated name or give the name to your collector.
15. Select an existing registered profile.

  1. Click FINISH.
    The integration is installed and displayed on the INSTALLED INTEGRATION page. Use the search field to find the installed integration.

Modify Oracle Cluster Integration

Discover Resources in Oracle Cluster Integration

  1. Navigate to Infrastructure > Search > DATABASES > Oracle Cluster. The Oracle Cluster page is displayed.
  2. Select the application on the Oracle Cluster page
  3. The RESOURCE page appears from the right.
  4. Click the ellipsis () on the top right and select View Details.
  1. Navigate to the Attributes tab to view the discovery details.

View resource metrics

To confirm Oracle Cluster Cluster monitoring, review the following:

  • Metric graphs: A graph is plotted for each metric that is enabled in the configuration.
  • Alerts: Alerts are generated for metrics that are configured as defined for integration.
  1. Click the Metrics tab to view the metric details for Oracle Cluster.

Version History

Application VersionBug fixes / Enhancements
2.0.0
  • Persona changes to support Oracle Cluster RAC and Standalone configurations.
  • oracle_dbInstance_Uptime - Metric unit and calculations are updated to minutes, previously it is in secs.
1.0.2Enhancements related to the latest snapshot, Activity Log and DebugHandler changes.
1.0.1Changes related to resource discovery.
1.0.0Initial support for Oracle Cluster application.