plugin deployment guide

Size: px

Start display at page:

Download "plugin deployment guide"

Lilian Andrews
6 years ago
Views:

1 plugin deployment guide July 2016 This document details the steps required when deploying the mongodb monitoring plug-in into Oracle Enterprise Manager 12c. The process is identical for Oracle EM 13c.

2 Prerequisites Oracle Enterprise Manager 12c R4 or above mongodb version or above The agent side host should be an EM supported Linux 32 or 64 bit platform. An Oracle EM or higher agent deployment is required on a selected management host. This may be remote to the mongodb installation. Authentication should be configured on the mongodb environment and a dedicated monitoring user configured in the admin database of each mongodb. This is used by EM to remotely monitor the target. A local mongo client installation is required on the monitoring host if remote javascript execution via the EM job system is used. mongodb java driver and json library jar files should be installed on the monitoring host. Please refer to the target addition guide for more information on the above. IMPORTANT: Plugin version requires Oracle EM version or higher. 2

3 Plug-in installation The plug-in should be installed into the EM environment using emcli. Following download of the opar file from please import using the following command as SYSMAN: emcli import_update -file={full path to opar file} -omslocal This imports the plug-in into the EM environment and makes it visible within the EM console eg: $ emcli import_update -file=/home/oracle/ _aidev.mongo.xdbs_2000_0.opar -omslocal Processing update: Plug-in - Aidev mongodb system monitoring plugin for Oracle Enterprise Manager Successfully uploaded the update to Enterprise Manager. Use the Self Update Console to manage this update. 3

4 Within Oracle Enterprise Manager, deploy the plug-in. Navigate to "Setup", Extensibility, "Plugins" then expand the "Databases" section: Select the mongodb Database plugin the version imported should be visible. 4

5 left click on "Deploy on" then "Management Servers" 5

6 enter the EM repository database SYS password then click "Continue" 6

7 ensure the prerequisites succeed then click "Next" 7

8 ensure the information on the Review page is correct, then click "Deploy" 8

9 click "Show Status" 9

10 the deployment job will be visible: 10

11 after a few minutes, this should succeed: 11

Appendix A Post upgrade steps If you have upgraded from an earlier release of the plugin and have mongodb targets within EM, please follow this important step for each target.

12 Appendix A Post upgrade steps If you have upgraded from an earlier release of the plugin and have mongodb targets within EM, please follow this important step for each target. Step 1 deploy the plugin to each management agent used to monitor mongodb targets. Navigate to "Setup" -> Extensibility -> "Plugins" then expand the "Databases" section. Select the mongodb Database plugin. 12

13 Left click on "Deploy on" then "Management Agent Ensure the correct plugin version is shown, then click Continue 13

14 Select the agent(s) you wish to upgrade the plugin on, then select Continue 14

15 Ensure the prerequisites succeed, click Next 15

16 Accept the warning and click Deploy : 16

17 Click Show Status to see the job: 17

18 The job will run and after a few minutes should succeed: AT THIS STAGE, ALL EXISTING MONGODB TARGETS ON THIS HOST WILL BE OF STATUS 'METRIC COLLECTION ERROR' 18

Step 2 Fix pre-existing mongodb targets This is required to resolve 'Metric Collection Error' status following an upgrade of the plugin to version 12.1.0.

19 Step 2 Fix pre-existing mongodb targets This is required to resolve 'Metric Collection Error' status following an upgrade of the plugin to version For each mongodb plugin, navigate to Target Setup Monitoring Configuration from either the target home page or by right clicking the target name on All Targets page 19

The following target properties introduced by v12.1.0.4.0 of the plugin need to be set: mongodb Environment ID set this to be a common reference to mongodb targets in a single environment.

20 The following target properties introduced by v of the plugin need to be set: mongodb Environment ID set this to be a common reference to mongodb targets in a single environment. For example, mongodb_hr_test SSL Enabled set this to TRUE if SSL communication between the agent and mongodb is required, otherwise set to FALSE SSL Truststore if SSL mode is used, set this to the full path of the SSL truststore on the agent host. Otherwise set to NONE. Set accordingly and click the OK button to apply Click OK to continue. 20

21 After a short period, the target should show as up: If this does not clear and targets remain in a 'Status Pending' state, please run the following commands against the agent: emctl clearstate agent emctl stop agent emctl start agent 21

22 NEED FURTHER INFORMATION? contact for more details on this product and how to join up with us. Copyright 2016 Aidev [A trading name of Wardrop Consulting Limited]. All rights reserved. MongoDB and the leaf logo are trademarks or registered trademarks of mongodb Inc or its affiliates in the U.S. and other countries. Microsoft, SQL Server, and Windows are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries. Oracle and Oracle Enterprise Manager are trademarks or registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners. Specifications and product offerings subject to change without notice. Please ensure you have appropriate licenses for running this product. Aidev takes no responsibility whatsoever re. site licensing of Oracle EM, mongodb or any other software used with this plugin this responsibility lies solely with the Client. 22

SSL Configuration: an example. July 2016

SSL Configuration: an example. July 2016 SSL Configuration: an example July 2016 This document details a walkthrough example of SSL configuration in an EM managed mongodb environment. SSL certificates are used to enforce certificate based security