F Collecting OCM Data Using Oracle Harvester

My Oracle Support provides a key set of features and functionality that greatly enhance the customer's interaction with Oracle Support. My Oracle Support streamlines the Service Request submission process by providing in-context information specific to a customer's configurations, as well as proactive support. To enable these features within My Oracle Support, the customer's configuration information must be uploaded to Oracle. When the configuration data is uploaded on a regular basis, customer support representatives can analyze this data and provide better service to customers.

The following mechanisms are provided to customers for collecting and uploading configuration data to Oracle.

  • Oracle Enterprise Manager Harvester (Oracle Harvester)

  • Oracle Configuration Manager (OCM)

In particular:

  • Oracle Configuration Manager is installed and configured automatically when you install an Oracle product.

    When installing any product, the first screen asks for My Oracle Support credentials. THIS IS A PIVOTAL SCREEN in the installation. The user name and password that you provide are the credentials against which the configuration data is uploaded to Oracle.

  • Configuration collections run and the configuration data is uploaded to Oracle every 24 hours.

  • Once the data is uploaded, it can be viewed by logging into My Oracle Support (https://support.oracle.com) using the same credentials supplied during product installation.

Note: If you use Enterprise Manager to manage your applications, we recommend that you use Oracle Harvester to upload your configurations to Oracle. Otherwise, use OCM.

F.1 Oracle Harvester

Oracle Harvester only harvests data for targets that are managed by Enterprise Manager. Because Oracle Harvester has the same OCM dependencies, Oracle Harvester enables the gathering of target configuration data by leveraging Enterprise Manager collection methods thus precluding the need to install OCM on target homes managed by Oracle Harvester.

Highlights of Oracle Harvester

The following are highlights of Oracle Harvester:

  • Data is uploaded by default for all targets against the same credentials with which OCM in the Oracle Management Service (OMS) home is configured. From Enterprise Manager Cloud Control 12c, you can change this default value for a target by assigning a CSI from the CSI Assignment page. Click Setup, then My Oracle Support to get started.

  • Requires OCM to be configured and running in the OMS home for Enterprise Manager.

  • Gathers target configuration data from the Management Repository

  • Automatically runs periodically so no user intervention is required

Oracle Harvester and OCM

When you install Enterprise Manager, Oracle Harvester and Oracle Configuration Manager (OCM) are automatically installed as are all the necessary subcomponents. The Oracle Harvester will run as long as the OCM in the OMS home is configured and running.

OCM must be enabled in the Oracle Home of the OMS and configured (and running in connected mode) in the Instance Home of the OMS. The reason is that the Oracle OMS target will not be discovered by the OCM collector if ORACLE_CONFIG_HOME is not set.

Perform the following steps to ensure the Oracle OMS target is discovered:

  1. Locate the OMS instance home.

    In the $ORACLE_HOME/sysman/config/emInstanceMapping.properties file (where ORACLE_HOME is the Oracle Home of the OMS), there is an entry referencing a file called emgc.properties.

    The directory in which the emgc.properties file is located is the "instance home" of the OMS. In the following example, /u01/app/oracle/product/gc_inst/em/EMGC_OMS1 is the instance home of the OMS:

    EMGC_OMS1=/u01/app/oracle/product/gc_inst/em/EMGC_OMS1/emgc.properties
    
  2. Set the environment variable ORACLE_CONFIG_HOME to the directory of this emgc.properties file.

    Example:

    $export ORACLE_CONFIG_HOME=/u01/app/oracle/product/gc_inst/em/EMGC_OMS1
    
  3. If My Oracle Support credentials were not provided during the Enterprise Manager installation, run the following command to set them:

    setupCCR
    

    Provide the My Oracle Support credentials when prompted.

For more information about the Oracle Configuration Manager (OCM), see the Oracle® Configuration Manager Installation and Administration Guide:

http://docs.oracle.com/cd/E49269_01/doc.12/e48361/toc.htm

Or visit the OCM documentation library:

http://docs.oracle.com/cd/E49269_01/index.htm

Support For Enterprise Manager Release 12.1

By default, all targets are uploaded using the credentials used to register Oracle Configuration Manager in the OMS Home. In Enterprise Manager release 12.1, you have the option of assigning a Customer Support Identifier (CSI) to each target home.

The Oracle Harvester supports uploading configuration data to different CSIs for each different Oracle Home.

The steps include:

  1. Ensuring that the Oracle Harvester has run. This job runs automatically. The status of the run can be monitored from the Support Identifier Assignment page. To access this page from the Enterprise Manager home page, select Setup, then select My Oracle Support. From the menu, select Support Identifier Assignment.

  2. Setting My Oracle Support preferred credentials. From the Enterprise Manager home page, select Setup, then select My Oracle Support. From the menu, select Set credentials and supply any valid My Oracle Support credentials.

  3. Assigning the Support Identifier.

    1. From the Enterprise Manager home page, select Setup, then select My Oracle Support. Select Support Identifier Assignment and provide the correct user name and password. Select Set credentials.

    2. Select Home. Click Assign button. Select CSI and click OK.

  4. Ensuring the message displays indicating the assignment was successful. The message reads:

    Support Identifier has been assigned for 1 Oracle homes. The changes in the Customer Support Identifiers will be reflected in My Oracle Support after the next Harvester run.
    

Viewing CSIs in Enterprise Manager

You can see the CSI associated with a target by viewing the target property or by doing a configuration search with CSI set as the search criteria. Any user with operator privilege on all targets for a given Oracle Home can assign a CSI for that Oracle Home.

Refer to the help in the Enterprise Manager interface on how to access this information.

Harvester Target Lifecycle Properties from Enterprise Manager

Oracle Harvester provides the target lifecycle property to enable you to identify the purpose of a target, for example, development, testing, and so on.

Once defined, the Oracle Harvester collects the target lifecycle property for all the targets and uploads the property to Oracle Configuration Manager server.

You can assign target lifecycle property to any target from either the Enterprise Manager UI or the My Oracle Support UI.

The possible values of a target's lifecycle property are:

  • Mission Critical

  • Production

  • Stage

  • Test

  • Development

Harvester Job Status Metric

From Enterprise Manager Cloud Control 12c Release 12.1.0.3 and OCM 10.3.8.1.0, a Harvester Job Status metric has been added to the OMS and Repository target. This metric will provide information related to the Harvester Job. The following information is collected as part of this metric:

  • Harvester Status: Provides the status of the last harvester job run. Possible values include:

    • SUCCESS: indicates the job ran successfully.

    • ERROR: returned if job failed.

    • NOT CONFIGURED: indicates that OCM is not configured.

    • NOT AUTHENTICATE: shows that OCM is configured, but it is not in Authenticated mode.

  • Harvester Error: Shows an error message in case the harvester job fails to run.

  • Last Harvester Job Run: Shows the time the last harvester job ran.

  • Next Harvester Job Run: Shows the time of the next harvester job run.

  • Total Targets Processed: Shows the number of targets processed by the harvester job during its last run.

  • Total Targets Successful: Total number of targets successfully uploaded to MOS from Total Targets Processed.

  • Total Targets Failed: Shows the total number of target that failed to upload to MOS out of the Total Targets Processed in the Last Harvester Job Run.

  • OCM Version: Shows the version of OCM configured with Enterprise Manager.

The Harvester Job Status metric data is available from the OMS and Repository target metrics page. An ERROR threshold has been defined for the Harvester Status field. If the value of this field shows ERROR, then an incident will be created, which will appear on both the OMS and Repository home page and the Incident Manager Page.

F.1.1 Supported Targets in Oracle Harvester

Depending on the release of Enterprise Manager that Oracle Harvester is running on, Oracle collects the configuration data from a different set of target types. Only configuration data from the target types shown in Table F-1 are collected by Oracle Harvester.

Table F-1 Supported Targets in Enterprise Manager 12.1 Releases

Target Plug-in Release Enterprise Manager Release
12.1.0.1 12.1.0.2 12.1.0.3

BI

12.1.0.3

No

Yes

Yes

Host

not applicable

Yes

Yes

Yes

Management Agent

not applicable

Yes

Yes

Yes

Management Repository

not applicable

Yes

Yes

Yes

Oracle Application Server

all versions

Yes

Yes

Yes

Oracle Database

all versions

Yes

Yes

Yes

Oracle Database Machine

all versions

Yes

Yes

Yes

Oracle Exadata Storage Server

all versions

Yes

Yes

Yes

Oracle Exalogic

12.1.0.2

12.1.0.3

No

No

Yes

No

Yes

Yes

Oracle Fusion Applications

all versions

Yes

Yes

Yes

Oracle Fusion Middleware

all versions

Yes

Yes

Yes

Oracle Home

not applicable

Yes

Yes

Yes

Oracle Identity Manager for configurations: OIF, OID, OVD and DIP

 

No

Yes

Yes

Oracle Identity Manager for configurations: OIM, OAM and OAAM

all versions

Yes

Yes

Yes

Oracle Management Service

not applicable

Yes

Yes

Yes

Oracle SOA Suite

all versions

Yes

Yes

Yes

Oracle Virtual Manager

all versions

Yes

Yes

Yes

Oracle WebLogic Server

all versions

Yes

Yes

Yes

Siebel

12.1.0.3

No

No

Yes


F.1.2 Configuration Data Not Available in My Oracle Support

In previous versions of Enterprise Manager, Oracle Harvester configuration data was only uploaded to My Oracle Support when 30 days had passed since the last upload of data by a standalone OCM Collector if such data already existed in My Oracle Support.

This restriction has been lifted in Enterprise Manager 12c. Configuration data for targets collected from Oracle Harvester running in Enterprise Manager release 12c displays in My Oracle Support immediately, regardless of how recently data was uploaded by a standalone OCM Collector.

F.2 Oracle Configuration Manager

Oracle Configuration Manager is installed and configured automatically when you install an Oracle product. It is installed in the product Home and collects configuration data for all targets installed in that Home.

The OCM setup requires specifying the My Oracle Support account and password, or My Oracle Support account and Customer Support Identifier (CSI). Configuration data will be uploaded using this information and can be viewed by logging in to My Oracle Support using the same credentials.

OCM must be installed in every Oracle Home from which you want to upload configuration data to Oracle. In addition to being part of the product installation, OCM can also be downloaded from My Oracle Support. The Mass Deployment tool is available to help with deploying OCM across data centers. The OCM kit is available from the Collector tab on My Oracle Support.

Once OCM is installed, no additional work is required. By default, automatic updates are enabled and you are encouraged to use this feature to ensure you are always running the latest version of OCM. This feature can be disabled if required, for example, for security reasons. If you disable the feature, you can turn it on by executing the following command:

<ocm_install_root>/ccr/bin/emCCR automatic_update on

Note: If you use Enterprise Manager or Ops Center to manage your applications, we recommend that you use Oracle Harvester or Ops Center Harvester respectively to upload your configurations to Oracle. Otherwise, use OCM.

F.3 Additional Information

To find additional information about My Oracle Support, see:

https://support.oracle.com

To find more information about OCM, perform the following steps:

  1. Log into My Oracle Support at https://support.oracle.com

  2. To access the Collector tab, click More and select Collector from the drop-down menu. The Collector page contains useful information.

F.4 Troubleshooting Configuration Data Collection Tools

The following sections describe how to resolve issues with the configuration data collections.

In Enterprise Manager release 12.1.0.2, ensure that collection data is uploaded to Oracle by using the emccr status command. Look at the last uploaded date and time.

Note: This emccr status command shows that collected data was uploaded, but does not ensure the Oracle Harvester collections were successful and uploaded.

Location of error logs:

  • Oracle Harvester error logs:

    • For Harvester Job errors, look at:

      INSTANCE_HOME/sysman/log/emoms_pbs.trc
      
    • UI errors, for example CSI Assignment errors, look at:

      INSTANCE_HOME/sysman/log/emoms.trc
      

      For example:

      /gc_inst/user_projects/domains/GCDomain/servers/EMGC_OMS1/sysman/log/emoms.trc
      
  • Oracle Configuration Manager log is located at:

    ccr/hosts/<hostname>/log/collector.log
    

F.4.1 Oracle Harvester Collection Fails If the state/upload/external Directory Is Missing

If the Oracle Harvester collection fails with the following error, the required directory named external is missing.

[JobWorker 75210:Thread-61] ERROR gcharvester.GcCollectionMgr initOcm.? - GC OCM
Harvester: Caught GC Harvester exception from GCInit.init(): The installed version
of Oracle Configuration Manager in the ORACLE_HOME
(/scratch/aime/work/midlwre8937/oms11g) is prior to 10.3.1. The Grid Control
Configuration harvesting requires at a minimum, 10.3.1

To resolve this issue, create the external directory:

$ORACLE_INSTANCE_HOME/ccr/state/upload/external

(Bug 12795503)

F.4.2 Oracle Configuration Manager Is Not Running

When OCM is not running, you may see the following error:

2012-08-29 16:34:20,709 [JobWorker 97285:Thread-60] WARN
gcharvester.HarvesterJobUtils performOCMCollections.? - GC OCM Harvester: OCM was
stopped and is not running 

To resolve this issue, verify that the OCM was installed and configured in the appropriate directories (execute emCCR status).

In particular, OCM must be installed in the OMS Oracle Home and configured (and running in connected mode) in the OMS Instance Home.

F.4.3 Configuration Data Not Available in My Oracle Support

When you look at My Oracle Support and do not find configuration data, it could be that the Oracle Harvester collection did not run.

To resolve this issue, verify that the OCM was installed and configured in the appropriate directories (execute emCCR status). In particular, OCM must be installed in the OMS Oracle Home and configured (and running in connected mode) in the OMS Instance Home.

To verify that OCM is running, perform the following steps:

  1. Set ORACLE_CONFIG_HOME to the INSTANCE HOME

  2. Execute $ORACLE_HOME/ccr/bin/emCCR status

F.4.4 Only a Subset of the Targets Is Collected by the Oracle Harvester

If many targets are uploaded to the Management Repository but only a subset of the targets is collected by the Oracle Harvester, it could be because the same error was encountered 10 times during a collection, causing the Oracle Harvester to stop collecting. Look at the appropriate log file to verify that this error has occurred.

Resolve the issue by running the following SQL script against the Management Repository. This script forces the Oracle Harvester to ignore this collection error and continue collecting the remaining target information.

sql> insert into mgmt_ocm_upl_props (name,str_value) values('ignore_errors','true');
sql> commit;

Bounce the OMS after executing the SQL script.

(Bug 11734389)