1. Using Oracle Infrastructure Monitoring
  2. Discovery
  3. Add Apache SOLR

Add Apache SOLR

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

Step 1: Prepare Apache SOLR for monitoring.

Prerequisites

Two modes are supported: standalone & solrcloud

Monitoring is done over REST APIs exposed by Apache SOLR

Monitoring credentials require read access to following URIs:

  • /admin/collections?action=clusterstatus

  • /admin/collections?action=overseerstatus

  • /admin/info/system

  • /admin/info/threads

  • /admin/cores

  • /<core_name>/admin/mbeans

Credentials

  1. Without Credentials:

    1. non-secure (http)

    2. secure (https)

  2. With Credentials:

    1. Client Authentication - (2–way SSL)

    2. Basic Authentication - non secure

    3. Basic Authentication - secure

    4. Basic Authentication with Client authentication

Step 2: Decide how you want to add the Apache SOLR entity.

You can add Apache SOLR 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 Apache SOLR Entity Type.
  3. Enter the following UI properties.
    Apache SOLR UI Fields
    • Discover Using Credentials: Discover Apache SOLR using Apache SOLR credentials (on by default).
    • Entity Name: Name of this entity displayed in the Oracle Management Cloud console.
    • Base URL: The base URL for REST API invocations.
    • Cloud Agent: Cloud agent monitoring the host where the Apache SOLR is installed.

    Monitoring Credentials

    Basic Authentication

    • Username: Apache SOLR username.
    • Password: Apache SOLR password.

    Client Authentication

    • Keystore Location: Full path to the location of the keystore file.
    • Keystore Password: Keystore authentication password.

    BasicClient

    Basic Authentication

    • Username: Apache SOLR username.
    • Password: Apache SOLR password.

    Client Authentication

    • Keystore Location: full path to the location of the keystore file.
    • Keystore Password: Keystore authentication 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.
    Apache SOLR JSON Files and Properties

    Definition Files:

    omc_solr_instance_credless.json

    omc_solr_instance_creds.json

    omc_solrcloud_credless.json

    omc_solrcloud_creds.json

    Credential Files:

    solr_basic_authentication.json

    solr_client_authentication.json

    solr_client_with_basic_authentication.json

    Replace any text inside brackets <> excluding these brackets with your values according the legend inside <>

    Notes:

    1. Credential JSONs are same for both standalone (omc_solr_instance) & solrcloud (omc_solrcloud)
    2. For secure solr standalone & solrcloud (with or without creds), server certificates for all the instances need to be added to the agent keystore using following command omcli secure add_trust_cert_to_jks -password welcome -trust_certs_loc <certificate location> -alias <alias>
    3. For client authentication the type of the agent keystore is JKS keystore

    Examples of Base URLs:

    non secure – http://<hostname>:<port>/solr/

    secure — https://<hostname>:<port>/solr/

    Example of credentialRefs in the entity JSONs:

    "credentialRefs" : ["SolrKeyStoreCredRef"] ---- for client authentication

    "credentialRefs" : ["SolrBasicCredRef"] ---- for basic authentication

    "credentialRefs" : ["SolrBasicCredRef","SolrKeyStoreCredRef"] ---- for client with basic authentication

  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 Apache SOLR, see the following: