README.

md 3/30/2020

User Installation Guide for 'OICOMC Monitoring'

Integration Package
Author: tyler.mast@oracle.com
Overview
. Pre-Requisites (Service Accounts)
. Connections
. Importing Pre-Configured Artifacts
. Understanding the Schedule Configuration Map
. Running the Package
Pre-Requisites (Service Accounts/Client Applications)
In order for communication to occur between OIC and itself/OMC, service accounts or client applications
(OAuth 2.0) with the proper permissions need to be created. The OIC account/client needs the Service
Developer permission and the OMC account/client needs OMC Administrator. The general
recommendation is to use OAuth for this purpose but Basic Auth can be used as well.
Importing the Package
The only thing that needs to be done to import all of the different integration artifacts is to import that
package archive (.par file). This file includes references to the required libraries, lookups, connections,
etc.
Connections
Once the package is imported, the connections should be given the credentials for the different
accounts/clients that were created beforehand. Note: The base URL for OIC should end at .com, but the
OMC url should end in .com/serviceapi to fit with the endpoints used in the integrations.
Oracle Management Cloud
Import the Log Sources and Log Parsers into OMC before running the orchestration to ensure that the
logs being pushed to OMC are being parsed correctly. The steps to do this are as such:
In OMC, navigate to Log Analytics -> Administration Home from the left navigation menu
From this page, click the cog in the top right of the screen and choose the "Import Configuration
Content" option from the menu
Using the dialogue, you can upload the two .zip archives for the two log sources (which contain the
parsers)
Understanding How to Configure the Package's Options
The entire data ingesting process is handled by a set of integrations. One of those integrations runs on a
schedule and calls the other ones via asynchronous API calls. All configuration is done in the scheduler
1/3
README.md 3/30/2020

and the configurations are passed to the other modules. Identifying the scheduler should be easy as it is
the only integration in the package that depends on the ESS scheduler (and will have a calendar icon in
the OIC UI).
The very first object in the scheduler is named "Configuration." It is a mapping object where
configurations can be hard-coded to be passed to the rest of the integrations.
The current configuration options are as follows:
(Switch) Collect Audit Logs - "ON"/"OFF"
On by default, but if you do not want to call the audit log collection module, set this to
anything other than "ON" ("OFF")
(Switch) Collect Service Metrics - "ON"/"OFF"
On by default, but if you do not want to call the module that collects information about the
OIC service instance, set this to anything other than "ON" ("OFF")
(Switch) Collect Integration Metrics - "ON"/"OFF"
On by default, but if you do not want to collect metrics on a per integration basis, then set
this to anything other than "ON" ("OFF")
(Switch) Monitor Connections - "ON"/"OFF"
On by default, but if you do not want to monitor connection health in OMC, then set this to
anything other than "ON ("OFF")
(Switch) Cleanup Entities - "ON/OFF"
Enables the module that routinely inspects OMC to remove entities that haven't been
updated in a certain amount of time
(Config) Entity Retention Period - "14"
The number used by the Cleanup Entities Module to determine how many days an entity
should stay in OMC without receiving an update
(Config) Audit Records Query - "{limit: '300'}"
The audit records API does not allow for queries by time-frame, so the request reduces the
amount of entries received by giving a hard limit to the number of entries inspected. They
are filtered to only process records that occur in the last ten minutes so changing the limit
shouldn't be necessary unless there are more than 300 audit records being generated every
ten minutes.
(Config) OMC Audit Logs Source - "OICOMC Audit Source"
The name of the audit logs source in OMC. If importing from the archive provided, this
should not need to be changed.
(Config) OMC Audit Logs Parser - "OICOMC Audit Parser"
The name of the audit logs parser in OMC. If importing from the archive provided, this should
not need to be changed.
(Config) OMC Integrations Log Source - "OICOMC Flow Logs"
The name of the integration logs source in OMC. If importing from the archive provided, this
should not need to be changed.
(Config) OMC Integrations Log Parser - "OICOMC Flow Logs"
The name of the integration logs parser in OMC. If importing from the archive provided, this
should not need to be changed.
Running the Package
2/3
README.md 3/30/2020

This package of integrations was designed to be run from the scheduler every ten minutes for the best
possible metric granularity and accuracy. If the scheduler is not set to run every ten minutes, it will miss
information such as audit logs and integration instance logs.

3/3