Monitoring EntireX Applications and Components

EntireX and other Software AG products provide multiple approaches to monitor your EntireX environment:

If you have already decided on a monitoring approach, the tables provide quick links to the relevant sections of the documentation. If you are unsure which approach to take, document Introduction to Monitoring Approaches describes the approaches briefly and links to the relevant sections of the documentation for further reading.


Table of EntireX Monitoring Approaches

This section lists various EntireX monitoring approaches. Links are provided to other sections of the EntireX documentation, where these approaches are described in more detail.

Monitoring Approach Description
Application Monitoring Monitor an application along its message path - measuring response times at multiple measuring points. graphics/toc_closed.png More info
Monitoring Scripts Monitor EntireX components (Broker and RPC Servers), either as snapshot or over time in CSV files. graphics/toc_closed.png More info
Monitoring from the Command-line Lists monitoring approaches from command-line which can be used for automation processes. graphics/toc_closed.png More info
Command Central Perform administrative tasks (configuration, management, monitoring, ...) remotely from a single location. graphics/toc_closed.png More info
Mainframe Broker Monitoring Monitor your mainframe broker with Command Central. graphics/toc_closed.png More info
webMethods EntireX Adapter for Integration Server Monitor the EntireX Adapter with the IS Administration Console, graphics/toc_closed.png More info
Watching the Default Broker View in Designer/Eclipse Quick status of the EntireX Default Broker and the active RPC services registered to it. graphics/toc_closed.png More info

Notes:

  1. The approach Application Monitoring monitors EntireX at application level along its message path - back and forth - measuring response times at multiple measuring points.
  2. All other approaches monitor EntireX at an infrastructure component level, for example EntireX Broker or EntireX RPC servers.

Table of Commmand-line Approaches

Utility Description z/OS Linux Windows BS2000
ETBCMD Take actions against a broker - for example purge a unit of work, stop a server, etc. graphics/toc_closed.png More info graphics/toc_closed.png More info graphics/toc_closed.png More info graphics/toc_closed.png More info
ETBINFO Query the broker for different types of information and format the output with profiles graphics/toc_closed.png More info graphics/toc_closed.png More info graphics/toc_closed.png More info graphics/toc_closed.png More info
EXXMSG Command-line utility for displaying text of an EntireX error message. graphics/toc_closed.png More info graphics/toc_closed.png More info graphics/toc_closed.png More info    

Introduction to Monitoring Approaches

EntireX and other Software AG products provide multiple approaches to monitor your EntireX environment:

The following difference is significant:

  • The first approach, Application Monitoring, monitors an EntireX application along its message path - back and forth - measuring response times at multiple measuring points.

  • The other approaches monitor EntireX on an infrastructure component level, for exampe EntireX Broker or EntireX RPC servers.

This section will help you decide on the right approach for your organization.

Application Monitoring

Application Monitoring is an EntireX feature that enables you to monitor the response times in your distributed applications, and it also enables you to monitor certain error situations. The heart of Application Monitoring is the EntireX Application Monitoring Data Collector, which collects the response time data of each involved software component of selected synchronous EntireX RPC services. The Application Monitoring Data Collector stores the KPI values in CSV (comma-separated values) files. The files can be processed by any third-party tool that supports CSV files, for example Microsoft Excel. Alternatively, you can hook in your own monitoring back end, using the callback user exit of the Data Collector.

  • Third-party Tool
    Use this method if you want to have a quick look at the results, using any tool that supports CSV files (for example Microsoft Excel).

  • Callback User Exit
    Use the callback user exit of the Data Collector to hook in your own monitoring back end. Write a Java class that implements the DataCollectorCallback interface and make it known to the Data Collector. Use this method if you want to feed arbitrary monitoring back ends in real time. See Callback User Exit under Setting up the External Application Monitoring Data Collector in the Application Monitoring documentation.

See the Application Monitoring documentation for more details.

Monitoring from the Command Line

There are three different ways of monitoring EntireX from the command line:

Command Central Command Line

Software AG Command Central is a tool you can use to perform administrative tasks remotely from a single location. It can assist with configuration, management and monitoring tasks. As an operator you can monitor server status and health, as well as start and stop servers from a single location. You can also configure alerts to be sent in case of unplanned outages. For each registered instance, you can see up to three KPIs in Command Central's instance overview.

Command Central offers a browser-based user interface, but you can also automate tasks by using commands to remotely execute actions from a terminal or custom script (for example CI servers such as Jenkins, or generic configuration management tools such as Puppet or Chef). It can assist with the following configuration, management, and monitoring tasks:

The core Command Central documentation is provided separately and is also available under Guides for Tools Shared by Software AG Products on the Software AG documentation website. See the following sections for EntireX-specific information:

ETBINFO

The command-line utility ETBINFO queries the Broker for different types of information, generating an output text string with basic formatting. This text output can be further processed by script languages. ETBINFO uses data descriptions called profiles to control the type of data that is returned for a request. ETBINFO is useful for monitoring and administering EntireX Broker efficiently - for example, how many users are to run concurrently and whether the number of specified message containers is large enough.

For more information see ETBINFO under z/OS | Linux | Windows | BS2000.

EntireX Monitoring Scripts

The monitoring scripts available with EntireX allow you to define your environment, to monitor it and to define actions in case of an error. Although the scripts are installed and run on Microsoft Windows, you can monitor your EntireX environment that is running on any other operating system. You can specify any broker accessible in the network, for example one running under z/OS. The scripts can be used with brokers of any supported EntireX version.

The monitoring scripts provide a solution to the following scenarios:

  • "I want a quick overview of my standard broker and a list of active external services that are running." graphics/toc_closed.png More info

  • "I want to monitor an EntireX component (broker, service, client) over time." graphics/toc_closed.png More info

  • "I want to monitor my environment and check that all components (broker, RPC servers) are up and running." graphics/toc_closed.png More info

You can select the scripts from the EntireX Monitoring Scripts Menu or call the individual scripts from the command-line. For more information see the separate documentation section EntireX Monitoring Scripts.

Monitoring EntireX with Command Central

Software AG Command Central is a tool that enables you to manage your Software AG products remotely from one location. Command Central offers a browser-based user interface, but you can also automate tasks by using commands to remotely execute actions from a terminal or custom script (for example CI servers such as Jenkins, or generic configuration management tools such as Puppet or Chef).

Command Central can assist with the following configuration, management, and monitoring tasks:

  • Infrastructure engineers can see at a glance which products and fixes are installed, where they are installed, and compare installations to find discrepancies.

  • System administrators can configure environments by using a single web user interface or command-line tool. Maintenance involves minimum effort and risk.

  • Release managers can prepare and deploy changes to multiple servers using command-line scripting for simpler, safer lifecycle management.

  • Operators can monitor server status and health, as well as start and stop servers from a single location. They can also configure alerts to be sent to them in case of unplanned outages.

The core Command Central documentation is provided separately and is also available under Guides for Tools Shared by Software AG Products on the Software AG documentation website. See the following sections for EntireX-specific information:

webMethods EntireX Adapter for Integration Server

For monitoring the webMethods EntireX Adapter for Integration Server (IS), your best choice is the IS Administration Console, which provides basic information as well as statistical values of connections, services and listeners. You can also reset the statistical values from the IS Administration Console.

See also Settings and Information in the EntireX Adapter documentation.

Watching the Default Broker View in Designer/Eclipse

The EntireX Default Broker View is part of the Designer. It displays the status of the EntireX Default Broker and the active RPC Services registered to it. Use it if you need to know whether your local default broker is running, or whether relevant RPC servers are connected to it. You can perform basic administration tasks on the local default broker and also shut down connected server instances or services.