VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR. Oracle Database. Installation & Configuration Guide

Transcription

1 VMWARE VREALIZE OPERATIONS MANAGEMENT PACK FOR Oracle Database Installation & Configuration Guide

2 TABLE OF CONTENTS 1. Purpose Installation and Configuration Requirements Licensing Requirements Installing the Management Pack Uploading the Installation File Adding a License Key Configuring the Management Pack Creating an Adapter Instance and Credential Manually Discovering Resources Validating Data Collection Appendix I: Management Pack Folders and Files Appendix II: Oracle Database User Privileges and Required Views Oracle Database Least Privileged User Oracle Database Required Views Appendix III: Enabling SSL Appendix IV: Revision Notes NOTE: This document supports the version of each product listed, as well as all subsequent versions, until a new edition replaces it. You can find the most up-to-date technical documentation on the Blue Medora support site at: The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: support@bluemedora.com. 2 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

3 1. Purpose The Blue Medora VMware vrealize Operations (vrops) Management Pack for Oracle Database Installation and Configuration Guide describes how to install and configure Blue Medora s VMware vrealize Operations Management Pack for Oracle Database. 2. Installation and Configuration Requirements Before installing and configuring the Management Pack for Oracle Database, ensure your system meets the following requirements: Table 1: Management Pack Installation & Configuration Requirements VREALIZE OPERATIONS (VROPS) REQUIREMENTS ORACLE DATABASE REQUIREMENTS VERSION(S) vrealize Operations v6.x (Enterprise edition only) Oracle Database NOTE: The list of Oracle Database views the Management Pack will access can be found in section 7. Appendix II: Oracle Database User Privileges and Required Views. CREDENTIALS N/A Oracle Database User Name/Password NOTE: Details regarding what level of user privileges must be granted for certain metrics can be found in section 7. Appendix II: Oracle Database User Privileges and Required Views. CONNECTION vrops hostname or IP address IP address or hostname of Oracle Database instance SID/Service Name required to connect to the instance Port number Non-SSL default: 1521 SSL default: 2484 NOTE: If using SSL, the SSL truststore containing the certificate must be copied to your vrops system prior to configuring an adapter instance. Refer to section 8. Appendix III: Enabling SSL for more information. 3. Licensing Requirements When purchased individually, the Management Pack for Oracle Database is licensed per Oracle Database instance. Alternatively, customers who have purchased Blue Medora s True Visibility Suite (Standard, Advanced, or Enterprise) can access all management packs within that suite (and the edition below it, if applicable). The Management Pack for Oracle Database is part of Blue Medora s Enterprise True Visibility Suite (TVS), which means a TVS Enterprise license is required to use it. For more information, visit A license key will be provided by Blue Medora when the Management Pack or True Visibility Suite is purchased and must be added as an Oracle Database Adapter License within vrealize Operations before the Management Pack can be configured and used. Refer to section 4.2 Adding a License Key, for details. 3 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

4 4. Installing the Management Pack Installing the Management Pack in vrealize Operations involves completing the following tasks: Uploading the Installation File Adding the License Key 4.1 Uploading the Installation File The Management Pack for Oracle Database is installed using a.pak file Prerequisites Obtain the Management Pack installation file from Read the release notes that are included with the.pak file Procedure 1. Save the.pak file in a temporary location. 2. Log in to vrealize Operations as an admin user. 3. Click the Home icon, then select the Administration navigation shortcut from the panel on the left. Figure 1: Home > Administration 4 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

5 4. In the right panel, the Solutions tab will be displayed. Figure 2: Solutions Tab 5. Click the Add icon ( ) to upload the.pak file to the vrealize Operations server. In the dialog that appears, browse to the location of the saved.pak file, then click Upload. NOTE: The.pak file upload may take several minutes to complete. Status information appears in the Installation Details text box throughout the installation process. Figure 3: Select the.pak file to upload 6. Click Next when the upload has finished. Read the End User License Agreement (EULA) and click the I accept the terms of this agreement checkbox to accept, then click Next. 7. Click Finish when the installation process is complete. NOTE: The installation utility creates the oracledb_adapter3 folder and oracledb_adapter3.jar file in the $VCOPS_BASE/user/plugins/inbound folder. Refer to section 6. Appendix I: Management Pack Folders and Files for more information. 5 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

6 4.2 Adding a License Key The Management Pack requires a valid license for full operation. Complete the following steps to license the Management Pack Install the License 1. In vrealize Operations Manager, navigate to Administration > Licensing > License Keys. 2. Click the Add icon ( ). In the dialog that appears, select Oracle Database. Figure 4: Add License 3. Enter your Blue Medora license key, then click Validate. If successful, License key validated successfully will be displayed. 4. Click Save to finish adding your license key Add the License to a Group NOTE: Adding a license to a license group is only necessary if using vrops In later versions, the License will automatically be added to a group. 1. Navigate to License Groups. 2. Select the license group OracleDatabaseAdapter Licensing, then click the Edit icon ( ). 3. Check the newly added license. 4. Enter a name for this license group, then click Next. 5. Select the resources to include/exclude in this group, then click Next. 6. Click Finish. 7. Navigate back to License Keys and click the Refresh License Usage icon ( ). 6 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

7 5. Configuring the Management Pack Configuring the Management Pack for Oracle Database includes the following tasks: Creating an Adapter Instance and Credential Manually Discovering Resources (if necessary) Validating Management Pack Data Collection 5.1 Creating an Adapter Instance and Credential You must create an adapter instance and credential for the Management Pack in order to define the adapter type and identify the database(s) from which the adapter instance will retrieve data Prerequisites Install the Management Pack for Oracle Database. Refer to section 4. Installing the Management Pack. If using SSL, the SSL truststore containing the certificate must be copied to your vrops system prior to configuring an adapter instance. Refer to section 8. Appendix III: Enabling SSL for more information Procedure 1. Log in to vrealize Operations as an administrator. 2. Click on the Administration navigation shortcut ( ). The Solutions view should automatically open. 3. Select Oracle Database from the Solutions list. Figure 5: Solutions List 7 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

8 4. Click the Configure icon ( ). The Manage Solution window will appear. Figure 6: Manage Solution Window NOTE: If adding multiple adapter instances, click the Add icon ( ) above the list of Instance Names on the left. 5. In the Manage Solution window, enter the following information: Adapter Settings: Display Name: A name for this particular instance of the Management Pack Description: Optional; most helpful for describing multiple adapter instances of the Management Pack Basic Settings: Host: Hostname or IP address of Oracle Database instance Port: Default port is 1521 (non-ssl); can be overridden (2484 for SSL) Connection Type: SID/Service Name SID (or Service Name): Enter the actual SID or Service Name, according to selection above. Credential: Click the Add icon ( ), then select the credential type (refer to Figure 7). Advanced Settings: Collector: Automatically selected Support Autodiscovery: True/False SSL Enable: True/False Query Count: Number to limit queries by 8 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

9 Order Queries By: Average Time/Elapsed Time/User I/O Wait Time/Buffer Gets/Physical Read Requests/Executions/Parse Calls/Sharable Memory/Child Count Figure 7: Manage Credential Credential Name: A name for this set of Management Pack credentials Username: Username for Oracle Database Role: Normal/SYSDBA/SYSOPER Password: Password for Oracle Database Truststore File Path: Location of the truststore (if SSL Enabled is True) Truststore Password: Password for the truststore (if SSL Enabled is True) 6. Click OK to save your credential. 7. Click Test Connection to ensure vrealize Operations can connect properly to the Oracle Database system. 8. Click Save Settings to save your adapter instance configuration. 9 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

10 5.2 Manually Discovering Resources If Autodiscovery was set to False when configuring the adapter instance, you will need to manually discover resources as described in this section. With manual discovery, the adapter sends a request to the database to return resources, which you then manually select to import into vrealize Operations Prerequisites Create an Oracle Database adapter instance and credential. Refer to the previous section, 5.1 Creating an Adapter Instance and Credential, for details Procedure 1. Log in to vrealize Operations as an administrator. 2. Click the Administration navigation shortcut ( ). 3. Click Environment Overview in the navigator pane. Figure 8: Environment Overview > Adapter Instances 4. Under Adapter Instances, select Oracle DB Adapter Instance. 10 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

11 5. Click the Discover Resources icon ( ) to open the Discover Objects window. Figure 9: Discover Objects Window 6. In the Discover Objects window, select the following information: The Collector to use NOTE: Unless you added additional collectors, the only available collector is your vrops server. Oracle DB Adapter for Adapter Type The applicable Adapter Instance Basic Discovery for Discovery Info Whether Only New Objects (select/de-select checkbox) should be collected 7. Click OK to start the discovery process. 8. The discovery process can take several seconds to several minutes. When it has finished, the Discovery Results window lists your resources. 9. Double-click each resource kind that contains resources to add. 10. Select options for each kind of resource. Refer to Table Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

12 Table 2: Resource Options OPTION Import Collect DESCRIPTION Import the resources but do not start collecting data. Resources appear in the resource list as Not Collecting; data is not stored; analysis is not performed. Import the resources and start collecting data. When you select the Collect check box, the Import check box is also selected. 11. Click OK. The Discovery Results window closes and the new resources appear What To Do Next If you did not select the option to start metric collection when you defined a resource, you can start metric collection after the resource is defined. To start collecting metrics for a resource, choose the resources, then click the Start Collecting icon ( ). 5.3 Validating Data Collection After you add an Oracle Database adapter instance, you will want to validate the data that it collects in vrealize Operations Prerequisites Add an Oracle Database adapter instance. Refer to section 5.1 Creating an Adapter Instance and Credential, for details Procedure 1. Select the Environment shortcut ( ). NOTE: If you enabled Autodiscovery for the adapter instance, it will create resources as soon as it begins collecting metrics. If you disabled Autodiscovery for the adapter instance, you must go back and discover resources manually before you can validate data collection. Refer to section 5.2 Manually Discovering Resources. 2. Under Inventory Trees, select All Objects, then expand the Oracle Database Adapter objects list. 3. Select a resource from the list, then click the Troubleshooting tab and All Metrics view to validate values against the data source. Figure 10: Oracle Database Adapter Objects Troubleshooting 12 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

13 6. Appendix I: Management Pack Folders and Files The installer places the Management Pack files in the oracledb_adapter3 folder under the $VCOPS_BASE/ user/plugins/inbound/ folder as shown below. Table 3: Management Pack Folders and Files FOLDER/FILE(S) FOLDER/FILE(S) DESCRIPTION conf lib dashboards (folder) describe.xml describe.dtd images (folder) open_source_license.txt oss_attribution.txt reports (folder) reskndmetrics (folder) resources (folder) version.txt views (folder) Refer to lib folder for entire list Contains.json files for Management Pack Dashboards Describes the Management Pack Used to validate describe.xml Contains.png files for AdapterKind, ResourceKinds, and TraversalSpec Open source license file Open source license file Contains.xml files for Management Pack Reports Contains.xml files for Dashboard Metric configuration Contains resources.properties file Contains version information Contains.xml files for Management Pack Views.jar files that contain the classes and resources used to implement the Management Pack 13 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

14 7. Appendix II: Oracle Database User Privileges and Required Views 7.1 Oracle Database Least Privileged User The following list contains the minimum Oracle Database user privileges required for the Management Pack. Ensure the Oracle Database user has these permissions granted: create session connect select on dba_datafiles select on dba_free_space select on dba_outstanding_alerts select on dba_tablespaces select on dba_temp_files select on dba_temp_free_space select on dba_undo_extents select on global_name select on gv_$archive_dest select on gv_$filestat select on gv_$instance select on gv_$parameter select on gv_$resource_limit select on gv_$session select on gv_$sgainfo select on gv_$sql select on gv_$sysmetric select on gv_$system_event select on gv_$system_wait_class select on gv_$tempstat select on v_$archive_dest select on v_$controlfile select on v_$database select on v_$datafile select on v_$filestat select on v_$instance select on v_$log select on v_$logfile select on v_$parameter select on v_$recovery_area_usage select on v_$resource_limit select on v_$rman_backup_job_details select on v_$tempfile select on v_$version 14 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

15 7.2 Oracle Database Required Views The following table lists the views that the Management Pack will access. As of the time of publishing, these views do not require the Oracle Tuning Pack. Table 4: Oracle Database Required Views RESOURCE TYPE VIEW NAME REQUIRED? VERSION Database, Tablespace dba_data_files Yes All Supported Tablespace, Instance dba_outstanding_alerts Yes All Supported Tablespace dba_tablespaces Yes All Supported Database dba_temp_files Yes All Supported Tablespace dba_temp_free_space Yes All Supported Database dba_undo_extents Yes All Supported Tablespace dba_free_space Yes All Supported ALL global_name Yes All Supported Instance gv$archive_dest Yes All Supported Database, Instance gv$filestat Yes All Supported Instance, Query gv$instance Yes All Supported Database, Instance gv$parameter Yes All Supported Instance gv$resource_limit Yes All Supported Instance gv$session Yes All Supported Instance gv$sgainfo Yes All Supported Query gv$sql Yes All Supported Instance gv$sysmetric Yes All Supported Instance gv$system_event Yes All Supported Instance gv$system_wait_class Yes All Supported Database gv$tempstat Yes All Supported Database v$archive_dest Yes All Supported Database v$controlfile Yes All Supported ALL v$database Yes All Supported Database v$datafile Yes All Supported Database v$filestat Yes All Supported ALL v$instance Yes All Supported Database v$log Yes All Supported Database v$logfile Yes All Supported Database v$parameter Yes All Supported Database v$recovery_area_usage Yes All Supported Database v$resource_limit Yes All Supported Database v$rman_backup_job_details Yes All Supported 15 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

16 RESOURCE TYPE VIEW NAME REQUIRED? VERSION Database v$tempfile Yes All Supported Database v$version Yes All Supported 8. Appendix III: Enabling SSL If your Oracle database system is set up to use SSL, you must copy a truststore containing the Oracle DB SSL certificate to your vrops machine prior to configuring an adapter instance. To create the JKS truststore, refer to step a/ of this Oracle blog post: Importing server and private key in Oracle wallet: 9. Appendix IV: Revision Notes This installation guide is updated with each release of the product, or when necessary. The following table provides its revision history. REVISION DATE DESCRIPTION REV SEP-2016 Added information to section 3. Licensing Requirements about Blue Medora s True Visibility Suite REV APR-2016 Initial release 16 Blue Medora VMware vrealize Operations Management Pack for Oracle Database Installation & Configuration Guide

17 You can find the most up-to-date technical documentation on the Blue Medora support site at: The Blue Medora website also provides the latest product updates. If you have comments about this documentation, submit your feedback to: Copyright 2016 Blue Medora Inc. All rights reserved. U.S. and international copyright and intellectual property laws protect this product. Blue Medora is a registered trademark or trademark of Blue Medora in the United States and/or other jurisdictions. The Oracle name (including Oracle Database) and logo are trademarks or registered trademarks of The Oracle Corporation in the United States and/or other jurisdictions. All other marks and names mentioned herein may be trademarks of their respective companies. Blue Medora 3225 N Evergreen Dr. NE Suite 103 Grand Rapids, MI bluemedora.com