OMEGAMON Data Provider architecture

OMEGAMON® Data Provider consists of two components: OMEGAMON Data Broker and OMEGAMON Data Connect.

Figure 1. Components of OMEGAMON Data Provider
Diagram of components: OMEGAMON Data Broker and OMEGAMON Data Connect.

OMEGAMON Data Broker

OMEGAMON Data Broker forwards data from sources, such as OMEGAMON monitoring agents, over a TCP network to OMEGAMON Data Connect.

OMEGAMON Data Broker is a plug-in for the Zowe™ cross-memory server.

Tip: You don't need to install Zowe. The Zowe cross-memory server is supplied with OMEGAMON Data Provider. For details, see Prerequisites for OMEGAMON Data Provider.

The Zowe cross-memory server runs in its own z/OS® address space on the same z/OS instance as the data source.

The behavior of OMEGAMON Data Broker is determined by plain-text key-value configuration parameters in the Zowe cross-memory server configuration member. The parameters include details such as the hostname and port on which OMEGAMON Data Connect is listening for data.

OMEGAMON Data Connect

OMEGAMON Data Connect receives data from OMEGAMON Data Broker, transforms the data from its original format, and publishes the data using one or more output methods.

Each instance of OMEGAMON Data Connect can publish to multiple destinations:

  • Multiple TCP destinations (sinks)
  • Multiple HTTP endpoints that accept POST requests
  • Multiple OpenTelemetry Transport Protocol gRPC (OTLP/gRPC) endpoints
  • One Prometheus metrics HTTP endpoint served by OMEGAMON Data Connect
  • One Kafka cluster

You can filter which tables and which fields to publish to each destination.

OMEGAMON Data Connect is a Java™ application developed using the Spring Boot framework. The framework provides features such as application metrics published to Prometheus by Micrometer, which you can use to monitor OMEGAMON Data Connect activity and performance. For details, see the Spring Boot documentation for the Spring Boot Actuator endpoints.

You can run OMEGAMON Data Connect on z/OS or on any platform that meets the Java requirements for OMEGAMON Data Connect.

The behavior of OMEGAMON Data Connect is determined by a YAML document, config/connect.yaml, in the OMEGAMON Data Connect user directory of your choice.

OMEGAMON Data Connect is a modular application that consists of multiple Java archive (JAR) files:

Core JAR file
A single JAR file that implements the core functionality of OMEGAMON Data Connect.

OMEGAMON Data Provider supplies the core JAR file in the OMEGAMON Data Connect installation directory in the following path:

lib/odp-server-version.jar

Mapping extension JAR files
A JAR file for each data source of OMEGAMON Data Provider.

Mapping extensions extend OMEGAMON Data Connect to support data from different sources. Typically, the source data from z/OS is in a proprietary binary format. Mapping extensions consist of Java classes that contain data and logic to map the source data to the output formats of OMEGAMON Data Connect. Mapping extension Java classes are sometimes referred to as mapping classes.

OMEGAMON Data Provider supplies mapping extension JAR files for OMEGAMON monitoring agents in the OMEGAMON Data Connect installation directory in the following path:

lib/ext/kpp-odp-model-version.jar

where kpp is the product code for the agent.

Other data sources must supply their own mapping extension JAR file. You must copy the mapping extension JAR file from the installation directory of that other software to your OMEGAMON Data Connect user directory.