Operations Bridge Manager

For Windows® and Linux operating systems

Software Version: 2018.05

Customized output from:

Operations Bridge Manager 2018.05 Integrations Guide

Document Release Date: May 2018

Software Release Date: May 2018

HPE logo

Legal Notices

Warranty

The only warranties for products and services of Micro Focus and its affiliates and licensors (“Micro Focus”) are set forth in the express warranty statements accompanying such products and services. Nothing herein should be construed as constituting an additional warranty. Micro Focus shall not be liable for technical or editorial errors or omissions contained herein. The information contained herein is subject to change without notice.

Restricted Rights Legend

Confidential computer software. Except as specifically indicated otherwise, a valid license from Micro Focus is required for possession, use or copying. Consistent with FAR 12.211 and 12.212, Commercial Computer Software, Computer Software Documentation, and Technical Data for Commercial Items are licensed to the U.S. Government under vendor's standard commercial license.

Copyright Notice

© Copyright 2015 - 2018 Micro Focus or one of its affiliates

Trademark Notices

Java is a registered trademark of Oracle and/or its affiliates.

Linux® is the registered trademark of Linus Torvalds in the U.S. and other countries.

Microsoft®, Windows®, Lync®, Windows NT®, Windows® XP, and Windows Vista® are either registered trademarks or trademarks of Microsoft Corporation in the United States and/or other countries.

Oracle is a registered trademark of Oracle Corporation and/or its affiliates.

UNIX® is a registered trademark of The Open Group.

This product includes an interface of the 'zlib' general purpose compression library, which is Copyright © 1995-2002 Jean-loup Gailly and Mark Adler.

 
Integrations Guide

About this guide

Integrating OBM with other software products is a great way to extend your IT management capability. This document describes some of the major integrations between OBM and other Micro Focus products, but does not consitute a full list of possible integrations. For a complete list of available product integrations, see the Integrations Catalog.

Choose the integration

Application Performance Management and Business Service Management (APM and BSM)
Business Value Dashboard (BVD)
Cloud Optimizer (CO)
Network Node Manager i (NNMi)
Operations Bridge Analytics (OBA)
Operations Bridge Reporter (OBR)
Operations Manager (OM)
Operations Orchestration (OO)
Service Manager (SM)
SiteScope (SiS)

Choose the product with which you want to integrate your OBM instance.

Choose your OBM deployment type

Classic
Container

Choose if you are running OBM in an Operations Bridge container deployment or a classic deployment.

Choose your OM type

OM for Windows
OM for UNIX or Linux

Choose if you are integrating with OM for Windows or OM for UNIX or Linux.

Choose if you use the OBM RTSM or an external UCMDB as Global ID generator

RTSM
External UCMDB

Choose if you use the OBM RTSM or an external UCMDB as Global ID generator.

Choose your APM or BSM version

BSM 9.26
APM 9.30
APM 9.40
APM 9.50

Choose the version of your APM or BSM system.

Choose your OBA version

OBA 2.3x
OBA 3.x

Choose the version of your OBA system.

Choose your OO version

OO 10.22 and higher

Choose the version of your OO system.

Choose the OBA integration type

OBM-OBA Cross Launch
OBM-OBA Event and Anomaly Integration
OBM-OBA Dashboard Integration

Choose the type of OBA integration you want to configure with OBM.

  • Cross Launch Integration: You can configure an integration that enables you to open OBA directly from OBM in the context of a specific event or host.

  • OBA alerts > OBM events: You can enable forwarding of OBA alerts to OBM, so that they are managed as OBM events.

  • OBA anomalies > OBM anomaly events: You can enable forwarding of OBA anomalies to OBM, so that they are managed as OBM anomaly events.

  • OBM Dashboard Integration: It is possible to configure a dashboard that displays the OBA user interface within OBM.

  • Log streaming: You can configure policies in OBM to collect data and forward it to OBA. This enables central configuration of log collection and normalization of the incoming data. To do so, configure a structured log file policy to collect data and a data forwarding policy to forward the data to OBM. For more information, see the OBA Online Help.

  • OBM event collection. You can connect your OBM instance as an OBM Event Collection source type in OBA so that the OBM event data is sent to OBA for further analysis. The OBM Event Collection collects events every 15 minutes. For more information, see the OBA Online Help.

Choose the OBR integration type for Reports

OBM Integration for Event, HI and KPI Reports
OBM Management Packs Integration for Enterprise Management Reports
OBM with Integrated APM

Choose the type of OBR integration you want to configure with OBM.

  • Event, HI and KPI Integration: OBR integrates with and collects OBM event data from the OBM database at regular intervals. The user and user group details are gathered from the Management database. The OBM Content Pack identifies the list of metrics that OBR must collect from each of these data sources. The corresponding topology and CI dimension data is collected from RTSM. OBR integrates with and collects Health and Key Performance Indicator metrics from OBM Service Health application; the metrics being stored in OBM Profile and Management databases.

  • OBM-Management Packs Integration: OBR integrates and collects historical and ongoing database performance metrics from the OBM Management Packs for Enterprise reports.
  • OBM Integrated with APM: In this configuration, the OBM system provides topology data for all nodes and fact data for Operations Events and KPI. The APM system provides fact data from RUM and BPM that are directly monitored by APM.

Choose the SiS integration type

Event integration
Topology integration
Drilldown integration
Configuring and deploying SiS monitors from OBM

Choose the type of SiteScope integration you want to configure with OBM.

  • Event integration: SiteScope can forward events to OBM.

  • Topology integration: SiteScope can forward topology information to OBM.

  • Drilldown integration: When SiteScope monitors are used to set the status of a configuration item (CI), you can drill down from the CI in OBM to a SiteScope monitor that contributes to the HI's status.

  • Configuring and deploying SiteScope monitors from OBM: OBM provides a script that enables you to import templates from a SiteScope server so that you can include them in aspects, thus allowing you to manage the configuration and deployment of SiteScope monitors from within OBM.

Choose the SM integration type

Incident forwarding between SM and OBM
Downtime forwarding from SM to OBM
Downtime notification from OBM to SM
View planned changes and incident details
Business Impact Report

Choose the type of SiteScope integration you want to configure with OBM.

  • Incident forwarding between SM and OBM: OBM enables you to forward events from OBM to SM. Forwarded events and subsequent event changes are synchronized back from SM to OBM. You can also drill down from OBM events to SM incidents or from SM incidents to OBM events.

  • Downtime forwarding from SM to OBM: You can create downtimes (also known as outages) in OBM based on Requests for Changes in SM.

  • Downtime notification from OBM to SM: OBM can send downtime start and end events to SM to notify operators when a downtime occurs. This provides additional information to the SM operator in case of a downtime that was not driven by an RFC.

  • View planned changes and incident details: This integration enables you to view planned changes and incident details in the Changes and Incidents and Hierarchy components in OBM.

  • The Business Impact Report integration enables Service Manager operators to launch an impact report from an incident in the context of the incident's affected CI. This opens an OBM KPI over time page, displaying the affected CI and impacted CIs and services, which allows the operator to categorize and prioritize the incident accordingly.

Choose the OM integration type

Event integration
Topology integration
Set up OBM in an environment managed by OM

Choose the type of OM integration you want to configure with OBM.

  • Event integration: Events from OM are displayed in the OBM Event Browser.
  • Topology integration: The OM topology can synchronize with the OBMRTSM topology. Using topology synchronization, the OM services are synchronized with OBM, and by using corresponding mapping rules, they are transformed into CIs stored in the RTSM.
  • Set up OBM in an environment managed by OM: You can set up OBM to run in an environment managed by OM, and set up forwarding targets for OM agent node creation.

View or print

You can view your customized document on the screen, or print it.

If you have a PDF print driver installed on your system, click Print to create PDF documents that are customized according to your selections. PDF print drivers are available from several open source and third-party providers.

Check your selections

The following steps are customized according to your selections. Check that your selections are correct.

 

If any selections are not correct, click Change.

Overview

The integration between OBM and OBA provides you with the following capabilities:

  • Cross launch integration. You can configure an integration that enables you to open OBA directly from OBM in the context of a specific event or configuration item (CI) of the type host.

  • OBA alerts > OBM events. You can enable forwarding of OBA alerts to OBM, so that they are managed as OBM events. OBA alerts are triggered by the OBA operator for the selected topology elements in OBA.

  • OBA anomalies > OBM anomaly events. Starting with OBA version 3.0, you can enable forwarding of OBA anomalies to OBM, so that they are managed as OBM anomaly events. OBA anomalies are triggered automatically by OBA when a greater deviation from the standard baseline is observed for a number of the monitored topology elements, such as metrics. Upon arrival of an anomaly event, you can set a rule that causes an alert to be created when the condition is met. This could be, for example, when the sufficient number of anomalies are detected or when the severity reaches the threshold.

  • OBM dashboard integration. It is possible to configure a dashboard that displays the OBA user interface within OBM. This can be done by adding OBA as a new component to OBM.

  • Log streaming. You can configure policies in OBM to collect data and forward it to OBA. This enables central configuration of log collection and normalization of the incoming data. To do so, configure a structured log file policy to collect data and a data forwarding policy to forward the data to OBM. For more information, see the OBA Online Help.

  • OBM event collection (forward events from OBM to OBA). You can connect your OBM instance as an OBM Event Collection source type in OBA so that the OBM event data is sent to OBA for further analysis. The OBM Event Collection collects events every 15 minutes. For more information, see the OBA Online Help.

Cross Launch

You can configure an integration that allows you to open OBA from OBM in the context of a specific event or node. This allows you to open analysis tools from OBA, such as log analytics and predictive analytics.

To set up the cross launch integration, do the following:

  1. Prerequisite. Set up LW-SSO between OBM and OBA. Make sure you have a Single Sign On (SSO) account created in OBM with the same admin credentials as OBA. Under authentication management, add trusted domain of OBA with port id if you are accessing from outside network.For information on configuring LW-SSO in OBA, see the OBA Hardening Guide.

  2. In OBM, log in as the administrator user or a user with the permissions to create tools. Navigate to Administration > Operations Console > Tools.

  3. In the CI Types pane, select the CI type for which you want to enable the cross launch.

  4. In the Tools pane, select New. Fill in the appropriate values on the General tab.

  5. On the Type tab, select URL.

  6. On the URL tab, specify a URL as seen in the following examples:

    To query a single specified host over the last day:

    http://<oba_application_server>:8080/opsa/#/logsearchpql?search=host%20withkey%20%22${event.node.dnsName}%22&selectedTimeRange=ONE_DAY&redirect

    To query all hosts over the last hour:

    http://<oba_application_server>:8080/opsa/#/logsearchpql?search=host%20withkey%20%20*&selectedTimeRange=ONE_HOUR&redirect

    To launch a specific dashboard:

    http://<oba_application_server>:8080/opsa/#/dashboard?search=DASHBOARD_NAME%20Dash%20dashboard&start=<event_time>&end=4h~1h&selectedTimeRange=CUSTOM_TIME&redirect

    Note The start time must contain the event time in milliseconds, for example from the OBM tool parameter, and the end time is defined by a duration, for example 4h~1h including four hours before the event time and one hour after the event time.

    To query a specified CI:

    http://<oba_application_server>:8080/opsa/#/logsearchpql?search=host%20withkey%20%22${ci.primary_dns_name}%22&selectedTimeRange=ONE_DAY&redirect

    Alternatively, use port 8443 when using HTTPS.

  7. To test the URL, click Test.

    Tip To seamlessly test and run the tool without being prompted for your credentials, a user with the same user name must exist in OBA.

  8. To use the cross launch from OBM, navigate to Workspaces > Operations Console > Event Perspective. Right-click the desired event and select Launch > Tools from the context menu. Select the tool you created above and click Run.

 

Alerts and Events Integration

To be able to manage OBA alerts and anomalies as OBM events, it is necessary to configure an OBA application server as an OBM monitored node. The Operations AgentThis means that you must have the Operations Agent installed on the OBA application server, which then enables monitoring the OBA alerts and anomalies and forwarding them to OBM.

Dashboard Integration

You can configure an OBM dashboard that displays the OBA user interface.

Note The OBA dashboard integration with OBM is not supported in Internet Explorer.

  1. Prerequisite. LW-SSO must be configured in the OBA environment. For information on configuring LW-SSO in OBA, see the OBA Online HelpOBA Hardening Guide.

    Note In order for LW-SSO authentication to work between OBM and OBA, you must use a user with the same name in OBM and OBA.

  2. On the OBA application server, locate /opt/HP/opsa/jboss/standalone/deployments/opsa-ui-web.war/WEB-INF/web.xml.

    As the root user, modify the following section from:

    <init-param>
    <param-name>X-Frame-Options</param-name>
    <param-value>SAMEORIGIN</param-value>
    </init-param>

    to

    <init-param>
    <param-name>X-Frame-Options</param-name>
    <param-value>Allow-From http(s)://<OBM gateway or load balancer FQDN>/opr-web</param value>

    Important Configuring X-Frame-Options to ALLOW-FROM <FQDN> is not supported by all browsers. For more details, see https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options.

  3. Restart the OBA application server by running the command opsa-server restart.

  4. Micro Focus recommends adding a mapping of the OBA IP and the OBA FQDN in the Windows hosts file in every client machine that will be used to access OBA.

  5. Delete the cookies of all browsers used to access OBM.

  6. Add the FQDN of the OBA environment to the list of trusted hosts in OBM in the Authentication Management section. Navigate to Administration > Users > Authentication Management. In the Single Sign-On Configuration section, click Edit to open the Single Sign On Editor panel and add the OBA FQDN to the list of trusted hosts.

  7. After you have completed the following workflow you will be able to open a log search based on an event in OBM focused on the last hour. In OBM, navigate to MyWorkspace and create a new page:

    1. Log in to OBM as the integration user (a user set up with the same name in OBM and OBA).

    2. Click New Page, then Add Component in the new page or Component Gallery on the menu. Then click Add External Component to create a new component.
    3. Specify a name for your component and the URL <oba server FQDN>:<port>/.

      Note that the URL must begin with http or https, and the slash at the end must not be omitted.

    4. In the Configure Wiring section, click Add Context and select EventChange.

    5. In the URL Parameters and Value for EventChange section, click New Parameter. Select Path and click OK. Enter opsa/#/logsearchpql as value. To perform an XQL search instead, you can enter opsa/#/logsearchxql.

    6. Click New Parameter again and select Query String. Enter search in the Name field and click OK. Enter the following value for the parameter:

      host%20withkey%20<< event.node.dnsName >>&selectedTimeRange=ONE_HOUR&redirect

      To alternatively perform an XQL search, you can enter the following:

      Text:%20error%20hostname%3d<<event.node.dnsName>>&selectedTimeRance=ONE_HOUR&redirect

      The attribute event.node.dnsName must be selected from the Attributes list.

    7. The finished URL pattern should be as follows:

      http(s)://example.example.net:<port>/opsa/#/logsearchpql?search=host%20withkey%20<< event.node.dnsName >>&selectedTimeRange=ONE_HOUR&redirect

      If you decided to perform an XQL search instead, your finished URL pattern should be as follows:

      http(s)://example.example.com:<port>/opsa/#/logsearchxql?search=Text:%20error%20hostname%3d<< event.node.dnsName >>&selectedTimeRance=ONE_HOUR&redirect

    8. Click OK to save the component.
  8. Add the component to a page. The component must be the full width of the page.

Tip For best results, use screen resolution 1920x1200 and maximize the browser.

Overview

OBR is a solution based on Big Data technology Vertica, and has been built to specifically address the challenges of reporting in dynamic IT environments. In addition to consolidating performance data and metrics from multiple domain-focused collectors, OBR also collects and collates specific information on the relationships between the IT elements and the business services. OBR provides sophisticated data collection and aggregation coupled with industry-leading report definition and generation capabilities.

OBM - OBR integration enables topology based service driven enterprise reporting on OpsBridge deployments. It also enables the use case of reporting on OpsBridge events, Health Indicators and KPIs. OBR reports can be interactively accessed in the context of a Configuration Item (CI) or Business View from the OBM Dashboard user interface.

In OBM - OBR integration (deployment scenario), Run-time Service Model (RTSM) is the source of topology information. OBR discovers and synchronizes topology information from RTSM. In OBM, this synchronization technique receives data from Operations Agent or Sitescope, NNMi, NNM iSPI Performance for Metrics. The following diagram shows the flow of data:

The Operations Bridge solution consolidates all events from the underlying components regardless of the source of the data. OBR, as a reporting solution, fetches these events from OBM over a long term. In this deployment, you can also view the application metrics from integrated APM applications such as BPM and RUM, and the physical and virtual system metrics from SiteScope, and Operations agent.

OBR processes the heterogeneous information and displays it in the reports in the form of charts and tables. It provides cross-domain reports that provide a unified view of the health, performance, and availability of the underlying infrastructure. This unified view shows how the underlying infrastructure is impacting your business services in the long-term.

For more deployment scenarios, see Operations Bridge Reporter documentation in the Documentation Portal.

You can configure APM or OBM as standalone topology and data sources.

In this configuration, the OBM system provides topology data for all nodes and fact data for operations, events and KPI. The APM/BSM system's profile database provides fact data from RUM, BPM, and SiteScope* that are directly monitored by it.

*SiteScope data can be directly accessed through APIs also.

The following areas can be reported in the deployment scenario where OBR is integrated with OBM:

  • System Performance
    • Operations Agent
    • SiteScope
  • Virtual Environment Performance
    • Operations Agent
    • SiteScope
    • VMware vCenter
    • Cloud Optimizer*

    *For more information on Cloud Optimizer content pack integration to report on the virtualization content, see OBR Documentation.

  • Network Performance
  • Operations Events and KPIs
    • OM Events
    • OBM Events
    • Service Health
  • End User Monitoring
    • Real User Monitor
    • Business Process Monitor
  • Enterprise Application Performance
    • Microsoft SQL Server
    • Microsoft Exchange Server
    • Microsoft Active Directory
    • Oracle
    • Oracle Weblogic Server
    • IBM WebSphere Application Server

For more information about OBR reports, see OBR Documentation.

Pre-requisites

Make sure to complete the following requirements before you integrate OBM with OBR for enabling enterprise reporting:

  1. Complete the installation requirements for OBR
    1. Pre-install requirements
    2. Install OBR
    3. Create the Vertica database
    4. Plan Configuration and perform the post-installation configuration in Configuration Wizard.
  2. Verify if you have completed the following steps on the OBM system:
    1. OBM is installed and configured successfully. For information, see OBM Documentation.
    2. If you are monitoring systems and applications using the Monitoring Automation component of OBM and Management Packs, make sure that necessary Management Pack policies are deployed. For more information, see OBR Documentation.
    3. If you are monitoring systems and applications using underlying OM servers and Smart Plug-ins (SPIs), make sure that necessary SPI policies are deployed.
    4. Make sure to deploy necessary OBM views that are shipped with OBR
      . This is an essential pre-requisite to enable topology collection from OBM into OBR. See Setup RTSM Topology Source for OBR.

Event, HI and KPI Integration

Complete the following tasks on the OBR server to Integrate OBM and OBR:

Points to note:

  • After upgrading to the OBM 10.x content pack, the K_Event_PropertyChanges and R_Event_propertyChanges tables are retained to store the History of Event Property changes. The Event property change history will be captured within the K_Event_HistoryLine and R_Event_HistoryLine tables in compressed xml format. Based on these tables any custom extensions can be designed.
  • For OMi versions till 9.x, the Initiated by ID metric from OMi event database is stored in the InitiatedByID column of K_Event_Ext table. In OMi 10.x and higher versions, the Initiated by ID metric from OBM event database is stored in the Event_temp2 [Event Temporary column2 ] column of K_Event_Ext table.

OBM Integrated with APM

Complete the following tasks on the OBR server to Integrate OBM and OBR:

Points to note:

  • After upgrading to the OBM 10.x content pack, the K_Event_PropertyChanges and R_Event_propertyChanges tables are retained to store the History of Event Property changes. The Event property change history will be captured within the K_Event_HistoryLine and R_Event_HistoryLine tables in compressed xml format. Based on these tables any custom extensions can be designed.
  • For OMi versions till 9.x, the Initiated by ID metric from OMi event database is stored in the InitiatedByID column of K_Event_Ext table. In OMi 10.x and higher versions, the Initiated by ID metric from OBM event database is stored in the Event_temp2 [Event Temporary column2 ] column of K_Event_Ext table.

OBM-Management Packs Integration

This integration helps to generate Enterprise Application Management reports related to enterprise applications like Oracle WebLogic, IBM WebSphere, Microsoft Active Directory, Microsoft Exchange Server, Microsoft SQL Server and Oracle. OBR integrates and collects historical and ongoing performance metrics from the OBM Management Packs.

Complete the following tasks on the OBR server to Integrate OBM and OBR:

Integrating OBM Dashboard with OBR Reports

This section provides information about integrating OBR with other monitoring solutions to simplify and enhance the experience of launching and viewing OBR reports.

You can launch OBR reports in the context of a Configuration Item (CI) or Business View from the OBM Dashboard user interface.

Integrating OBR with OBM Dashboard enriches the component gallery and provides a convenient way to view all the OBM and OBR reports in one place, without launching OBR.

Integrating OBM with OBR

Overview

Operations Orchestration (OO) provides a simple way for customers to run scripts for automated actions. The integration with OBM uses the OO capabilities for building investigation tools or service remediation scripts, providing the operations with a simple way to validate a problem, investigate it, or automatically correct it. A run book can be executed manually.

OO run books can be launched from the Service Health and Event Browser OBM components.

The integration of OBM and OO provides the capability of mapping CI types to OO run books.

After you create such mappings, you can run the mapped OO run books:

  • On CIs, by using the Invoke Run Books context menu option. The OO run book parameters are populated by using the map to the CI attributes defined in the Run Book Mapping Configuration wizard. For detailed information about the wizard, see the OBM Administer.
  • At the event level. OBM receives an event. The event must match the specified event filter and the event's related CI's CI type must be mapped to the run book.The OO run book parameters are populated by using the map to the CI or event attributes defined in the Run Book Mapping Configuration wizard. For detailed information about the wizard, see the OBM Administer.

    You can also manually execute a run book by selecting the option for a selected event in the Event Browser's event context panel.

Integration

Complete the following workflow to integrate OBM and OO.

Troubleshooting

Use the following information to troubleshoot problems with your OBM-OO integration.

Overview

Important In the following sections, we will refer to the product as BSM, and to the integration of BSM 9.25 and later, and APM 9.309.409.50, with OBM as the APM Integration.

The Application Performance Management (APM) integration of BSM with OBM enables you to:

  • Integrate user interface components from separately deployed APM systems directly into the OBM's MyWorkspace pages. In this way, relevant information is shown directly within the OBM user interface, although this data comes from the BSM system.

  • Use the OBM embedded graphing component to show performance data stored within the Profile database of the BSM system.

  • Create a MyWorkspace page in OBM to drill down to detailed information about business transactions, business transaction flows, or location-based monitoring within BSM. For this purpose, OBM provides drill-down operations that allow to launch the BSM user interface in the context of a specific CI or event.

For information on supported versions, see the Integrations Catalog.

Integration

Troubleshooting and Maintenance

The following topics describe how to troubleshoot and maintain your OBM-APM integration.

Overview

SiteScope is an agentless monitoring solution that enables you to remotely monitor the availability and performance of your IT infrastructure (for example, servers, operating systems, network devices, network services, applications, and application components). The SiteScope integration with OBM has multiple parts, which can be enabled individually or in combination with one another. The parts of the integration are:

  • Event integration: SiteScope can forward events to OBM.
  • Topology integration: SiteScope can forward topology information to OBM.
  • Drilldown integration: When SiteScope monitors are used to set the status of a configuration item (CI), you can drill down from the CI in OBM to a SiteScope monitor that contributes to the HI's status.
  • Configuring and deploying SiteScope monitors from OBM: OBM provides a script that enables you to import templates from a SiteScope server so that you can include them in aspects, thus allowing you to manage the configuration and deployment of SiteScope monitors from within OBM.

Integration

Complete the following workflow to configure and use the SiteScope integration:

Best Practices

Follow these best practices when setting up your OBM-SiS integration.