Velocimetrics provides a real-time flow, volume and latency performance analysis. It is hardware based, and it includes a flow monitoring correlation engine. Velocimetrics Health Monitoring (VMX) integration with Geneos enables you to retrieve health statistics from the VMX servers using the JMX API and display them as dataviews in Geneos.
This guide walks you through the integration process.
This user guide is intended for users who are setting up, configuring, troubleshooting and maintaining this integration.
You should be familiar Python and Java, and with the administration of the JMX servers.
The following requirements must be met prior to the installation and setup of the template:
- Java 1.7 or higher
LD_LIBRARY_PATHenvironment variable set.
JAVA_HOMEenvironment variable set.
For more information on how to configure the environment variables, see JMX Plug-In - Technical Reference in JMX Plug-in Technical Reference.
- URL of the service you will be connecting to.
- Username and password, if required.
- Username and password, if required.
- You must have Java installed on the machine running the Netprobe. For information on supported Java versions, see Java support in Geneos 5.x Compatibility Matrix.
- Once you have Java installed, configure the environment variables required by the Netprobe so that it can locate the required resource files. For guidance, see Configure the Java environment.
Caution: The Java installation and environment configuration is a common source of errors for users setting up Java-based components and plug-ins. It is recommended to read Configure the Java environment to help you understand your Java installation.
The VMX monitoring integration is largely pre-configured and involves four primary steps:
- Download the integration files from the resources site.
- Load the integration file in the Gateway Setup Editor.
- Associate the samplers with a managed entity.
- Connect to a VMX server.
Note: The include files are intended to be read-only and should not be edited (unless the integration specifically requires for them to be modified). This is because include files can be shared between a few instances of a Gateway and best practice is to share them in their default state. It is also to make the upgrades and maintenance process of the integration files easier. All configuration should be carried out in your local Gateway files instead.
- Download the integration package
geneos-integration-vmx-<version>.zipfrom the ITRS Downloads site.
- As a best practice, save the files on the same machine where your Gateway is running.
The integration package includes a number of files. This is the file that determines the integration setup:
include/vmx_include.xml— Gateway configuration file (also called an include file) containing JMX samplers configured for VMX monitoring.
To load the integration files into the Gateway Setup Editor, follow these steps:
- Open Gateway Setup Editor.
- In the Navigation panel, click Includes to create a new file.
- Enter the location of the file to include in the Location field. In this example, it is the
- Update the Priority field. This can be any value except
1. If you input a priority of
1, the Gateway Setup Editor will return an error.
- Expand the file location in the Include section.
- Select Click to load.
- Click Yes to load the new include file.
Gateway configuration now appears in the Includes section.
For more information on the dataviews associated with the VMX integration, see the Velocimetrics Health Monitoring Technical Reference.
After you have loaded the configuration file, the VMX monitoring samplers become available for use. To associate the samplers with a managed entity, follow these steps:
- In the Gateway Setup Editor, create a new managed entity by right-clicking the Managed entities folder.
- Under the Basic tab for the new managed entity, add pre-configured samplers.
- Apply the managed entity to the running netprobe.
- Click Validate current document to check your configuration.
- Click Save current document to apply the changes.
For more information about include files, see the Gateway Setup Editor.
To connect to a VMX server, you need the URL of the server, and username and password (if required).
- In the Gateway Setup Editor, open a configuration window of one of the pre-configured samplers.
- Under the Basic tab of the JMX-server plugin, provide the URL of the VMX server you want to connect to.
- Provide username and password (if required).
- Validate and save your changes.
Repeat the steps for each sampler.
After you save your changes to the managed entity, the VMX dataviews appear under the managed entity on the state tree.
After you have included the monitoring samplers, you can learn about its dataviews and environment configuration in the Velocimetrics Health Monitoring Technical Reference.