This document describes the steps necessary to install and configure Replication Monitoring.
Configuring Event Replicator for Adabas to send Statistics, Events and Heartbeats
Configuring Adabas Analytics Collector MF using the Event Replicator Target Adapter Administration
Import and Explore Adabas Analytics Collector MF Kibana Examples
To use Replication Monitoring, the following products must be installed:
Adabas Analytics Collector MF 1.1 or above.
Event Replicator for Adabas 3.6.1 or above. Details on the installation of Event Replicator for Adabas can be found under Installation.
Event Replicator Target Adapter 3.3 or above. Details on the installation of Event Replicator Target Adapter can be found under Installing Event Replicator Target Adapter.
Note:
This is a prerequisite if you want to use Heartbeat.
Event Replicator Target Adapter Administration 3.3. or above. Details on the installation of Event Replicator Target Adapter Administration can be found under Installing Event Replicator Target Adapter Administration.
Elasticsearch 6.2.4 or above. Details on the installation and setup of Elasticsearch can be found under https://www.elastic.co/guide/en/elasticsearch/reference/current/index.html.
Kibana 6.2.4 or above. Details on the installation and setup of Kibana can be found under https://www.elastic.co/guide/en/kibana/current/index.html
Elasticsearch and Kibana are open source and available for download at https://www.elastic.co/products.
There are four Event Replicator for Adabas parameters that can be setup via the Adabas Event Replicator Subsystem, or in the Replication startup parameters (DDKARTE ADARPD statement) to receive Replication metrics, Replication Events, and Replication Heartbeats:
ADARPD STATINTERVAL=interval
The value for interval
specifies how often the Event Replicator Server should send out statistics. The value is
specified in seconds and the minimum value is 60. A value of 0 means statistics
are not sent.
For more information read about the
STATINTERVAL
parameter .
ADARPD DESTINATION NAME=destination_name ... DSTATLOG=YES ...
The DSTATLOG=YES parameter specified as
part of a destination definition tells the Event Replicator Server to send the replication
statistics to the Adabas Analytics Collector MF environment.
For more information read about the
DSTATLOG
parameter .
ADARPD DESTINATION NAME=destination_name ... DEVENTLOG=YES
The DEVENTLOG=YES parameter should be
specified as part of the Adabas Analytics Collector MF destination set up. This
option instructs the Event Replicator Server to send replication event information to the
Adabas Analytics Collector MF environment.
For more information read about the
DEVENTLOG
parameter.
ADARPD DESTINATION NAME=destination_name ... DHBINTERVAL=interval DCLASS=SAGTARG
The value interval
specifies how often Event Replicator Server should send heartbeats to this destination. The
value is specified in seconds and the minimum value is 60. A value of 0 means
heartbeat events are not sent. This parameter can be separately applied to each
destination.
It can only be used with destinations that also specify
DCLASS=SAGTARG i.e. where the Destination target is the Event Replicator Target Adapter.
It is possible to specify multiple destinations to receive the statistics, events, and heartbeats, or a single destination may be defined.
For more information read about
DHBINTERVAL
parameter.
For Elasticsearch, open a Command Prompt (Windows) or a telnet session (UNIX) and type:
cd <Elasticsearch_install_dir>/bin elasticsearch
Where <Elasticsearch_install_dir> is the path to your Elasticsearch installation.
For Kibana, open a Command Prompt (Windows) or a telnet session (UNIX) and type:
cd <Kibana_install_dir>/bin kibana
Where <Kibana_install_dir> is the path to your Elasticsearch installation.
To add an Adabas Analytics Collector MF environment:
Start Event Replicator Target Adapter Administration.
Go to Window > Preferences, select Adabas Analytics Collector MF and click .
Enter a name to identify this Adabas Analytics Collector MF environment.
In the Root Directory field:
If the installation of the Adabas Analytics Collector MF is a local installation, click the button and navigate to <SAG_install_root>/AdabasAnalyticsCollectorMF.
If the installation of the Adabas Analytics Collector MF is on a remote host, check the Remote box and manually enter the fully qualified path to the product root.
Click .
This is an optional step. Click the button to validate the settings you entered.
Click to add this Adabas Analytics Collector MF environment for management.
Click to exit Preferences.
Further details are also given in Setting Configuration File and Preferences
To configure an Elasticsearch target to receive the Event Replicator for Adabas
statistics and events:
In the Event Replicator Target Adapter Administration, expand the node you just created for this Adabas Analytics Collector MF environment.
Expand the Targets node.
Right click on Elasticsearch and click New.
Enter the information to identify your Elasticsearch installation.
For the Index use "reptor_monitor" if you plan to use the provided Adabas Analytics Collector MF examples.
Save the target definition under a name of your choice using the Save icon or File > Save.
Further details are also given in Configuring Target Definitions for Adabas Analytics Collector MF
To configure an Elasticsearch target to receive Event Replicator Target Adapter metrics and
Event Replicator Server heartbeats:
Please take care that the following ports are not in use already and ensure - depending on your configuration and/or firewall settings - that these ports are open for inbound communication.
| Port number | Used for |
|---|---|
| 4981 | Adabas Analytics Collector MF shutdown |
| 4000 | Event Replicator Target Adapter JMX metrics |
| 9200 | Elasticsearch |
| 9300 | Elasticsearch |
| 5601 | Kibana |
Expand the Targets node.
Right click on Elasticsearch and click New.
Enter the information to identify your Elasticsearch installation.
For the Index use "targetadapter" if you plan to use the provided Adabas Analytics Collector MF examples.
Save the target definition under a name of your choice using the Save icon or File > Save.
Further details are also given in Configuring Target Definitions for Adabas Analytics Collector MF
To configure a source to receive statistics and events from
mainframe Event Replicator for Adabas:
Expand the Sources node.
Right click on either EntireX Communicator or Websphere MQ and click New.
Enter the information to identify the message queue where you will receive statistics and/or events.
For the target pick the target you created above to receive Event Replicator for Adabas statistics and events.
Save the source definition under a name of your choice using the Save icon or File > Save.
Further details are also given in Configuring Source Definitions for Adabas Analytics Collector MF
To configure a source to receive Event Replicator Target Adapter metrics and Event Replicator Server
heartbeats:
Right click on Target Adapter under the Sources node and click New.
Enter the information to identify where your Event Replicator Target Adapter publishes its metrics to JMX beans. This is the port identified as the "JMX Port" during installation of the Event Replicator Target Adapter, by default port 4000.
If you are unsure of what port to use, look for the value set
for the variable ART_JMX_PORT in the file
installArtPath.bat (.sh for UNIX)
under the Event Replicator Target Adapter installation location.
For the Target pick the target you created above to receive Event Replicator Target Adapter metrics and Event Replicator Server heartbeats.
Save the source definition under a name of your choice using the Save icon or File > Save.
Further details are also given in Configuring Source Definitions for Adabas Analytics Collector MF
Start the Event Replicator Target Adapter from the Event Replicator Target Adapter Administration as described in Starting Event Replicator Target Adapter from the Administration Tool .
If you are planning to use IBM MQ Series as a messaging source, you will need to obtain the following jar files and copy them into your Adabas Analytics Collector MF installation:
com.ibm.mq.jar
com.ibm.mqjms.jar
dhbcore.jar
Copy these jar files into this location: <SAG_install_root>/AdabasAnalyticsCollectorMF/jars/lib.
To restart the Adabas Analytics Collector MF
Restart the now configured Adabas Analytics Collector MF service (Windows) or daemon (UNIX).
On Windows, use the Services applet to restart the service called Software AG Adabas Analytics Collector MF v1.0.0.x Service.
On Linux, execute the commands eapStopDaemon.sh
and eapStartDaemon.sh found in the
<SAG_install_root>/AdabasAnalyticsCollectorMF/sh
directory.
Examine the Adabas Analytics Collector MF log file at <SAG_install_root>/AdabasAnalyticsCollectorMF/log/EAPMonitorMain.log.
Look for any lines that contain ERROR to identify any potential problems.
Important:
Follow this step in order for the provided Adabas Analytics
Collector MF examples to work.
To verify the installation
Ensure your replication environment is set up to perform replication from Adabas to an Event Replicator Target Adapter target.
Perform at least one update or insert or delete on your source Adabas nucleus. This will:
cause replicated data to flow from Event Replicator for Adabas to Event Replicator Target Adapter;
cause Event Replicator for Adabas statistics, events, and heartbeats and Event Replicator Target Adapter metrics to flow to Adabas Analytics Collector MF and on to Elasticsearch;
populate the Elasticsearch data points including the necessary schema;
allow Kibana to interpret the data points and schema and allow the provided Adabas Analytics Collector MF examples to work.
To import Adabas Analytics Collector MF Kibana Examples
Open Kibana:
Open a browser and point to your Kibana installation (default is http://localhost:5601).
Create index patterns:
In the Kibana menu (left pane) click Management.
In the Management pane (right pane) click Index Patterns.
Under Define index pattern locate the Index pattern text box and enter "targetadapter-*".
Click button .
Under Configure settings locate the Time Filter field name drop down box and select field timestamp.
Click button Create index pattern.
Near the upper left corner of the window click button to create another index pattern.
Under Define index pattern locate the Index pattern text box and enter "reptor_monitor-*".
Click button .
Under Configure settings locate the Time Filter field name drop down box and select field timestamp.
Click button Create index pattern.
Import the Kibana Examples:
Near the upper left corner of the window click tab Saved Objects.
Near the upper right corner click button .
Navigate to the Adabas Analytics Collector MF Kibana examples directory.
The default location should be <install_root>/third-party/Kibana-Examples.
Select file EAP-everything.json and click button .
If prompted with "Automatically overwrite all saved objects?" click button .
If prompted with "Index Pattern conflicts":
o use the drop down boxes under New index pattern to map:
ID "targetadapter-*" to the new index pattern "targetadapter-*" and
ID "reptor_monitor-*" to "reptor_monitor-*".
Click button .
You should then see 13 saved Dashboards and 44 Visualizations.
To explore Adabas Analytics Collector MF Kibana Examples
Open Kibana (if not already open):
Open a browser and point to your Kibana installation (default is http://localhost:5601).
Open any dashboard:
Click Dashboard in the left hand pane.
Click on any dashboard name. Suggested starting points are:
ReptorMonitor: Global for Event Replicator for Adabas statistics and/or events.
Event Replicator Target Adapter Dashboard for Event Replicator Target Adapter metrics.
Latency for flow timing of the whole system.
Replicator Heartbeat Dashboard for heartbeats.
You should see many visualizations that change as replication flows from the source Adabas nucleus through Event Replicator for Adabas through messaging down to Event Replicator Target Adapter and on to the target RDBMS(s) or other Event Replicator Target Adapter target types.
To import your own dashboards and visualizations from Kibana
5.1.2
If you have an existing installation of Elasticsearch/Kibana 5.1.2 and you have created your own dashboards and visualizations that you want to preserve, it is suggested that you do an "Export Everything" from your Kibana 5.1.2 installation. Then back up your Elasticsearch data and delete your .kibana index. Then follow normal Elastic upgrade instructions and finally import all of your dashboards and visualizations into your new Kibana 6.2.4 installation.