Velocimetrics Health
Overview Copied
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.
Audience Copied
This guide is intended for users who are setting up, configuring, troubleshooting and maintaining this integration. This is also intended for users who will be using Active Console to monitor data from JMX servers.
You should be familiar Python and Java, and with the administration of the JMX servers.
Prerequisites Copied
The following requirements must be met before the installation and setup of the template:
- Java 1.7 or higher
LD_LIBRARY_PATH
environment variable set.JAVA_HOME
environment variable set.For more information on how to configure the environment variables, see Configuring environment in JMX Plugin.
- URL of the service you will be connecting to.
Java requirements Copied
- You must have Java installed on the machine running the Netprobe. For information on supported Java versions, see Java support in Geneos 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.
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.
Installation procedure Copied
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 files Copied
- Download the integration package
geneos-integration-vmx-<version>.zip
from 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.
Load the integration files Copied
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
vmx_include.xml
. - Update the Priority field. This can be any value except
1
. If you input a priority of1
, 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.
Success
Gateway configuration now appears in the Includes section.
Associate the samplers with a managed entity Copied
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.
Connect to a VMX server Copied
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.
Success
After you save your changes to the managed entity, the VMX dataviews appear under the managed entity on the state tree.
Metrics and dataviews Copied
The sections below list metrics and example dataviews available with the VMX integration.
VMX Artemis Agent Copied
This sampler provides a list of your available VMX Artemis Agent metrics.
Column Name | Description |
---|---|
Name | Name of the available Java object (Mbean) attribute. |
Value | Value of the available Java object (Mbean) attribute. |
VMX Artemis Cluster Copied
This sampler provides a list of your available VMX Artemis Cluster metrics.
Column Name | Description |
---|---|
Name | Name of the available Java object (Mbean) attribute. |
Value | Value of the available Java object (Mbean) attribute. |
VMX Artemis Cache Copied
This sampler provides a list of your available VMX Artemis Cache metrics.
Column Name | Description |
---|---|
Name | Name of the available Java object (Mbean) attribute. |
Value | Value of the available Java object (Mbean) attribute. |
VMX HeapMem Copied
This sampler provides a list of your available VMX HeapMem metrics.
Column Name | Description |
---|---|
Name | Name of the available Java object (Mbean) attribute. |
Value | Value of the available Java object (Mbean) attribute. |
VMX NonHeapMem Copied
This sampler provides a list of your available VMX NonHeapMem metrics.
Column Name | Description |
---|---|
Name | Name of the available Java object (Mbean) attribute. |
Value | Value of the available Java object (Mbean) attribute. |