Add Oracle NoSQL Database

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

Step 1: Prepare Oracle NoSQL Database for monitoring.

Credentials
Monitoring of Oracle NoSQL is supported only through credential-less JMX (no credentials JSON file is needed).

Step 2: Decide how you want to add the Oracle NoSQL Database.

You can add Oracle NoSQL Database 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 NoSQL Database Entity Type.
3. Enter the following UI properties.

   Oracle NoSQL UI Fields

   Entity Name: Your Oracle NoSQL Database entity name. Host Name: Name displayed in the Oracle Infrastructure Monitoring User Interface. URL: The NoSQL database connection URL. Port: The NoSQL database port. Store Name: Oracle NoSQL Database store name. NoSQL Java Home: Java home of NoSQL database or any Java home of version above 1.8 . KV Home Location: KV home of the NoSQL database. Cloud Agent: Agent monitoring the host on which the database is installed.

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 NoSQL JSON Files and Properties

   Definition File: omc_nosql_db_sample.json name: Your Oracle NoSQL Database entity name. displayName: This is Oracle NoSQL Database Entity Display Name which is displayed on Infrastructure Monitoring UI. timezoneRegion: Time zone of your entity. It is recommended that you use the long values IANA-maintained TZ database time zones. For example: America/New_York host_name: Under “value”, provide the fully-qualified host name where the Oracle NoSQL Database is installed. omc_port: Under “value”, list the NoSQL Database port. omc_url: Connection URL to connect to the installed Oracle NoSQL database. Comma separated host:port of all Nosql nodes of a store. example: <host_name>:<port>,<host_name>:<port> omc_nosql_java_home: Under “value”, list the Java home of NoSQL database or any Java home of version above 1.8 . omc_kv_home: Under “value”, list the KV home of the NoSQL database.

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 NoSQL Database, see the following:

• Lack of Data
• Create an Agent Support Bundle