Configuring integration with Operations Analytics - Log Analysis
Before you begin
- Use a supported combination of product versions. For more information, see Required products and components. The best practice is to
install the products in the following order:
Tip: The best practice is to install the WebGUI and Operations Analytics - Log Analysis on separate hosts.Restriction: Operations Analytics - Log Analysis does not support installation in Group mode of IBM® Installation Manager.
- Netcool/OMNIbus 8.1.0 and the WebGUI
- Gateway for Message Bus. Install the gateway on the same host as the Netcool/OMNIbus product.
- Operations Analytics - Log
see one of the following links:
- 1.3.7: see https://www.ibm.com/docs/en/SSPFMY_1.3.5/com.ibm.scala.doc/install/iwa_install_ovw.html
- 1.3.3: see https://www.ibm.com/docs/en/SSPFMY_1.3.3/com.ibm.scala.doc/install/iwa_install_ovw.html
- Netcool/OMNIbus Insight® Pack, see Installing the Tivoli Netcool/OMNIbus Insight Pack.
- Ensure that the ObjectServer that forwards event data to
Operations Analytics - Log
Analysis has the NmosObjInst column in the alerts.status table. NmosObjInst is supplied by default and is required for this
configuration. You can use ObjectServer SQL commands to check for the column and to add it if it is
missing, as follows.
- Use the DESCRIBE command to read the columns of the alerts.status table.
- Use the ALTER COLUMN setting with the ALTER TABLE command to add NmosObjInst to the alerts.status table.
- Configure the WebGUI
server.init file as
follows:Note: The default values do not have to be changed on WebGUI 8.1.0 fix pack 5 or later.
Restart the server if you change any of these values. See https://ibm.biz/BdXcBc.
scala.app.keyword=OMNIbus_Keyword_Search scala.app.static.dashboard=OMNIbus_Static_Dashboard scala.datasource=omnibus scala.url=protocol://host:port scala.version=188.8.131.52
- Select and plan a deployment scenario. See On-premises scenarios for Operations Management. If your deployment uses the Gateway for Message Bus for forwarding events via the IDUC channel, you can skip step 5. If you use the AEN client for forwarding events, complete all steps.
- Start the Operations Analytics - Log Analysis product.
- Familiarize yourself with the configuration of the Gateway for Message Bus. See https://ibm.biz/BdEQaD. Knowledge of the gateway is required for steps 1, 5, and 6 of this task.
The term data source has a different meaning, depending on which product you configure. In the WebGUI, a data source is always an ObjectServer. In the Operations Analytics - Log Analysis product, a data source is a source of raw data, usually log files. In the context of the event search function, the Operations Analytics - Log Analysis data source is a set of Netcool/OMNIbus events.
- Configure the Gateway for Message Bus.
At a high-level, this involves the following:
For more information about configuring the gateway, see the Gateway for Message Bus documentation at https://ibm.biz/BdEQaD.
- Creating a gateway server in the Netcool/OMNIbus interfaces file
- Configuring the G_SCALA.props properties file, including specifying the .map mapping file.
- Configuring the endpoint in the scalaTransformers.xml file
- Configuring the SSL connection, if required
- Configuring the transport properties in the scalaTransport.properties file
If you are ingesting data that is billable, and do not want data ingested into the Netcool Operations Insight data source
to be included in the usage statistics, you need to set the Netcool Operations Insight data source
as non-billable. Add the path to your data source (default is NCOMS, see following step) to a seed
file and restart Operations Analytics - Log
Analysis as described in
one of the following topics:
Note: Ensure you follow this step before you configure an
- 1.3.7: see https://www.ibm.com/docs/en/SSPFMY_1.3.5/com.ibm.scala.doc/admin/iwa_nonbill_ds_t.html
- 1.3.3: see https://www.ibm.com/docs/en/SSPFMY_1.3.3/com.ibm.scala.doc/admin/iwa_nonbill_ds_t.html
omnibusdata source for Netcool/OMNIbus events.
- In Operations Analytics - Log
start the Add Data Source wizard and configure
omnibusdata source for Netcool/OMNIbus events.Only a single data source is required. The event management tools in the WebGUI support a single data source only.
- In the Select Location panel, select
Custom and type the Netcool/OMNIbus server
hostname. Enter the same hostname that was used for the JsonMsgHostname transport property of the Gateway for Message Bus.
- In the Select Data panel, enter
the following field values:
Field Value File path NCOMS. This is the default value of the jsonMsgPath transport property of the Gateway for Message Bus. If you changed this value from the default, change the value of the File path field accordingly. Type This is the name of the data source type on which this data source is based.
- To use the default data source type, specify OMNIbus1100.
- To use a customized data source type, specify the name of the customized data source type; for example: customOMNIbus
- In the Set Attributes panel, enter
the following field values:
Field Value Name omnibus. Ensure that the value that you type is the same as the value of the scala.datasource property in the WebGUI server.init file. If the Name field has a value other than omnibus, use the same value for the scala.datasource property. Group Leave this field blank. Description Type a description of your choice.
- In the Select Location panel, select Custom and type the Netcool/OMNIbus server hostname.
Configure access to the data source you set up in the previous step. This involves the
following steps in the administrative settings for Operations Analytics - Log
For information about creating and modifying users and roles in Operations Analytics - Log Analysis, see one of the following links:Note: The contents of the Netcool/OMNIbus Insight Pack dashboards are empty unless you log in with a user that has a role assigned with permissions to access the data source.
Create a role using the Roles tab, for example,
noirole, and ensure you assign the role permission to access the data source.
Add a user, for example,
noiuser, and assign the role you created that has permissions to access the data source (in this example,
- Create a role using the Roles tab, for example,
- Configure the Accelerated Event Notification (AEN)
- Configure AEN event forwarding in the Gateway for Message Bus.
- Configure the AEN channel and triggers in each ObjectServer
by enabling the following postinsert triggers and trigger group:
These items are included in the default configuration of the ObjectServer, as well as the SQL commands to configure the AEN channel, but they are disabled by default. For more information about configuring the AEN client in an integration with the Operations Analytics - Log Analysis product, search for Configuring event forwarding using AEN in the Gateway for Message Bus documentation.
- Start the Gateway for Message Bus in
SCA-LA mode. The gateway begins sending Netcool/OMNIbus events to Operations Analytics - Log Analysis.
- Install the WebGUI with the event search feature.
What to do next
- Install any available interim fixes and fix packs for the Operations Analytics - Log Analysis product, which are available from IBM Fix Central at http://www.ibm.com/support/fixcentral/ .
- You can customize event search in the following ways:
- Change the Operations Analytics - Log Analysis index configuration. For more information, see Customizing events used in Event Search using the DSV toolkit. If you change the index configuration, also change the map file of the Gateway for Message Bus. After the map file is changed, restart the gateway. For more information, search for Map definition file at https://ibm.biz/BdEQaD.
- Customize the Operations Analytics - Log Analysis custom apps that are in the Insight Pack, or create new apps. For more information, see Customizing the Apps.
- Customize the WebGUI event list tools. For more information, see Customizing event management tools.
- If the WebGUI and Operations Analytics - Log Analysis are on the same host, configure single sign-on to prevent browser sessions expiring. See Configuring single sign-on for the event search capability.