Streaming OMEGAMON data from Kafka to the Instana

You can use Z Common Data Provider to read and stream OMEGAMON® data from Kafka to the Instana.

1. Deploy the IBM OMEGAMON Instana Integration Proxy on a suitable host. The IBM OMEGAMON Instana Integration Proxy enables the monitoring data of OMEAGAMON to send resource and metric data to an IBM Instana server. For more information about IBM OMEGAMON Instana Integration Proxy, see Integrating with IBM OMEGAMON.
2. Install an Instana OS agent on a suitable host, and verify that the Instana OS agent is installed and communicating with your Instana server. The IBM OMEGAMON Instana Integration Proxy and Instana OS agent can be on the same host. For more information about Instana OS agent, see Host agent.
3. Configure the Instana OS agent to communicate with the IBM OMEGAMON Instana Integration Proxy. To enable the IBM OMEGAMON Instana Integration Proxy sensor, in the ibmapmproxy section of the agent configuration file instana_agent_install_dir/etc/instana/configuration.yaml, uncomment the lines of the host, port and protocol for the sensor and update the parameters, for example:

   com.instana.plugin.ibmapmproxy:
     enabled: true
     # host: Provide the hostname or IP address of the system where the APM-Proxy server is running.  No quotation marks are needed.
     host: 'INSERT_HOST_HERE' # APM-Proxy host
     # port: provide the port defined for contacting the APM-Proxy server. No quotation marks are needed.
     port: 443 # APM-Proxy port Default
     datainterval: 1 # Default
     heartbeatinterval: 15 # Default  
     # protocol: indicate whether to connect with the APM-Proxy server using the secure (SSL) port or the insecure port.  Values are either "http" or "https".  Default is "https".  No quotation marks are needed. Ensure the value provided for the "port" variable is the appropriate port for your server.
     protocol: https # Default
   

   For more information, see Integrating with IBM OMEGAMON.

   Note: The IBM OMEGAMON Instana Integration Proxy acts as the APM-Proxy server.
4. Copy the procedure HBODSPRO in the hlq.SHBOSAMP library to a user procedure library.
   You can rename this procedure according to your installation conventions.
5. In your copy of the procedure HBODSPRO, customize the following parameter values and environment variables for your environment:

   mode=kafka

   If you specify this parameter, the Data Streamer will consume OMEGAMON data from the Apache Kafka server that is specified in the KAFKA_SERVER environment variable or the customized Apache Kafka consumer properties file, and send the data to the subscribers that are defined in the policy. For more information, see KAFKA_SERVER and KAFKA_PROPER.

   Note: Even if you specify this parameter, the Data Streamer can still receive the data from the data gatherers. In other words, by specifying mode=kafka, the Data Streamer can process data from both the data gatherers and Apache Kafka.

   KAFKA_SERVER

   The address list of Apache Kafka bootstrap servers. It is a comma-separated list of host:port pairs.

   KAFKA_PROPER

   The full path for the customized Apache Kafka consumer properties file. The default path is CDP_HOME/gatherer.consumer.properties.

   Important: You must specify the address list of Apache Kafka bootstrap servers either in the KAFKA_SERVER environment variable or in the customized Kafka consumer properties file. If you specify both, the value in the KAFKA_SERVER environment variable will take effect.

   For more information about the customization of the procedure HBODSPRO, see Configuring the Data Streamer.
6. Create a policy to stream OMEGAMON data stream.
   1. Click the Create a new policy box.
   2. In the resulting Policy Profile Edit window, type or update the required policy name and, optionally, a policy description.
   3. Click the Add Data Stream icon .
   4. Select OMEGAMON data stream and click Select.
      OMEGAMON data stream is shown as a node in the graph.
   5. Click the Configure icon on the OMEGAMON data stream node to configure Kafka Topic Name.
      The value of the File Path will be updated automatically to be consistent with the value of the Kafka Topic Name that you fill in.
   6. Click the Subscribe icon on the OMEGAMON data stream node, the Policy Profile Edit window opens where you can select a previously defined subscriber, or define a new subscriber by completing the following steps.
      Note: Do not stream OMEGAMON data and other data to a same logstash.

      1. In the Subscribe to a data stream window, click the Add Subscriber icon .
      2. In the resulting Add subscriber window, update the associated configuration values, and click OK to save the subscriber.
         You can update the following values in the Add subscriber window:

         Name

         The name of the subscriber.

         Description

         An optional description for the subscriber.

         Protocol

         The streaming protocol that the Data Streamer uses to send data to the subscriber. For example, you can choose Instana if you want to use Instana as a subscriber. Make sure you choose the protocol that meets your requirements. For more information about protocols, see Subscriber configuration.

         Host

         The host name or IP address of the host where the IBM OMEGAMON Instana Integration Proxy is running.

         Port

         The port on which the subscriber listens for data from the Data Streamer. The default port of Instana subscriber is 7777.

      3. In the Subscribe to a data stream window, select one or more subscribers, and click Update Subscriptions.

         The subscribers that you choose are then shown on the graph.

      4. To save the policy, click Save.
   For more information about creating a policy to stream OMEGAMON data, see Creating a policy to stream OMEGAMON data stream.
7. Start the Data Streamer by running the following command.

   START HBODSPRO