Add Oracle JVM Runtime

You can add Oracle JVM Runtime entities using the Add Entity UI or using the cloud agent command line interface (omcli) with the appropriate JSON files.

Step 1: Prepare Oracle JVM Runtime for monitoring.

Prerequisites

Monitoring Oracle JVM Runtime can be performed in the following modes:

  1. No user authentication, No SSL
  2. No user authentication, SSL
  3. User authentication, No SSL
  4. User Authentication, SSL

SSL configuration:

You will need to import your truststore certificate into the cloud agent truststore using omcli as shown in the following example:

$ omcli secure add_trust_cert_to_jks  -alias <Alias of cert to import> -trust_certs_loc <Cert file to import>

Step 2: Decide how you want to add the Oracle JVM Runtime.

You can add Oracle JVM Runtime entities using one of two ways:

  • Add them from UI
  • Use the agent's omcli add_entity command with the appropriate JSON files

Adding Entities from the UI

  1. From the Management Cloud main menu, select Administration, Discovery, and then Add Entity. The Add Entity page displays.
  2. Select the Oracle JVM Runtime Entity Type.
  3. Enter the following UI properties.
    Oracle JVM Runtime UI Properties
    • Discover Using Credentials: Discover JVM Runtime using JVM credentials (on by default).
    • Entity Name: Name of the JVM Runtitme entity appearing in the UI.
    • Host Name: The host where is the JVM application is running.
    • JMX Port Number: The JMX port where the JVM application is running.
    • Cloud Agent: The cloud agent monitoring the JVM application.

    Monitoring Credentials

    • JMX Remote Access Username: JVM username.
    • JMX Remote Access Password: JVM password.

See Add Entities from the Console for detailed instructions on using the Add Entity UI.

Using omcli and the Appropriate JSON Files

  1. Download and extract the required JSON file(s) from the master JSON zip file. See the table below for the specific JSON files you'll need.
  2. Edit the file(s) and specify the requisite properties shown below.
    Oracle JVM Runtime JSON Files and Properties
    Definition File: omc_jvm_sample_creds.json
    • JVM host name (hostname) - the host where is the JVM application is running. It is specified during discovery in the discovery JSON or discovery UI. The value populated during discovery is the value specified by the user in discovery parameters
    • JVM application JMX port (omc_jmx_port) - the JMX port where the JVM application is running. It is specified during discovery in the discovery JSON or discovery UI. The value populated during discovery is the value specified by the user in discovery parameters
    • JVM runtime name (omc_runtime_name) - value determined by querying runtime MBean value Name (. The format of the value is <pid>@hostname.
    • JVM application JMX service URL (omc_jmx_service_url) - This values is calculated from the typical remote JMX service URL format -
      service:jmx:rmi:///jndi/rmi://<hostname>:<jmx_port>/jmxrmi 
      where the hostname and jmx port is determined from the values specified by the user in the discovery parameters.
    • JVM application class name - (omc_jvm_application_class_name) - value determined by querying runtime MBean value SystemProperties. The value is located by the key "sun.java.command" in the list of system properties.
    • JVM application instance command line arguments (omc_jvm_app_command_line_args) - value determined by querying runtime MBean value InputArguments. The value retuned by the MBean is formatted from an array to space delimted string. This is the command line arguments specified by the user when the JVM application is started
    Identifying properties

    The identifying properties specified in the target model for reconciliation purposes are the following:

    • host_name
    • omc_jmx_port
    • omc_jvm_application_class_name

    Credential File: omc_jvm_sample_creds.json

    • user_name: JVM username.
    • password: JVM password.
  3. Add the entity using omcli.
    omcli add_entity agent DEFINITION_FILE [-credential_file CREDENTIAL_FILE [-encryption_method_gpg]] 
  4. Verify the status of the newly added entity.
    omcli status_entity agent DEFINITION_FILE

See step 4. Adding Entities to Your Service of Add Entities Using JSON Files for more information.

Step 3: (Optional but recommended) Set up alerts.

To enable lights-out monitoring, you can set up alert rules to generate alerts and send notifications if your entities have performance issues.

See Set Up Alert Rules and Set Up Alert Thresholds and Notifications.

Troubleshooting

If you run into any issues regarding discovery or monitoring of Oracle JVM Runtime, see the following: