---
title: "Velocimetrics Health"
description: ""
url: "https://docs.itrsgroup.com/docs/geneos/7.11.0/collection/vmx-health/index.html"
---
## Overview


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

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


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](https://docs.itrsgroup.com/docs/geneos/7.11.0/collection/jmx-server/index.html).
- URL of the service you will be connecting to.


### Java requirements

- You must have Java installed on the machine running the Netprobe. For information on supported Java versions, see [Java support in Geneos Compatibility Matrix](https://docs.itrsgroup.com/docs/all/geneos/7x-geneos-compat-matrix/index.html#java-support).
- 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](https://docs.itrsgroup.com/docs/geneos/7.11.0/collection/netprobe/configuration/configure-the-java-environment/index.html).

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](https://docs.itrsgroup.com/docs/geneos/7.11.0/collection/netprobe/configuration/configure-the-java-environment/index.html) to help you understand your Java installation.

## Installation procedure

The VMX monitoring integration is largely pre-configured and involves four primary steps:

1. Download the integration files from the resources site.
2. Load the integration file in the Gateway Setup Editor.
3. Associate the samplers with a managed entity.
4. 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

1. Download the integration package `geneos-integration-vmx-<version>.zip` from the [ITRS Downloads](https://resources.itrsgroup.com/downloads) site.
2. 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

To load the integration files into the Gateway Setup Editor, follow these steps:

1. Open Gateway Setup Editor.
2. In the **Navigation** panel, click **Includes** to create a new file.
3. Enter the location of the file to include in the **Location** field. In this example, it is the `vmx_include.xml`.
4. 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.
5. Expand the file location in the **Include** section.
6. Select **Click to load**.
7. Click **Yes** to load the new include file.
![VMX integration file](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-ug-load-integration-file.png)


**Success**


Gateway configuration now appears in the **Includes** section.



### Associate the samplers with a managed entity

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:

1. In the Gateway Setup Editor, create a new managed entity by right-clicking the **Managed entities** folder.
2. Under the **Basic** tab for the new managed entity, add pre-configured samplers.
3. Apply the managed entity to the running netprobe.
4. Click **Validate current document** ![](https://docscdn.itrsgroup.com/geneos/images/Icons/validate22x22.png "icon") to check your configuration.
5. Click **Save current document** ![](https://docscdn.itrsgroup.com/geneos/images/Icons/save16x16.png "icon") to apply the changes.

![VMX managed entity](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-ug-add-managed-entity.png)

For more information about include files, see the [Gateway Setup Editor](/collection/../processing/configuration/gse_user_guide/).

### Connect to a VMX server

To connect to a VMX server, you need the URL of the server, and username and password (if required).

1. In the Gateway Setup Editor, open a configuration window of one of the pre-configured samplers.
2. Under the **Basic** tab of the JMX-server plugin, provide the URL of the VMX server you want to connect to.
3. Provide username and password (if required).
4. Validate and save your changes.

Repeat the steps for each sampler.

![VMX sampler](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-ug-connect-to-a-vmx-server.png)


**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

The sections below list metrics and example dataviews available with the VMX integration.

### VMX Artemis Agent

This sampler provides a list of your available VMX Artemis Agent metrics.

![VMX Artemis Agent](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-tr-artemis-agent-dataview.png)

<div class="table-container">
<table class="legacy-table" style="width: 100%;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" class="TableStyle-ref_2_col_table" cellspacing="0">
                    <col class="TableStyle-ref_2_col_table-Column-Column1" style="width: 240px;"/>
                    <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Column Name</th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Name</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Name of the available Java object (Mbean) attribute.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">Value</td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Value of the available Java object (Mbean) attribute.</td>
                        </tr>
                    </tbody>
                </table>
                
</div>

### VMX Artemis Cluster

This sampler provides a list of your available VMX Artemis Cluster metrics.

![VMX Artemis Cluster](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-tr-artemis-cluster-dataview.png)

<div class="table-container">
<table class="legacy-table" style="width: 100%;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" class="TableStyle-ref_2_col_table" cellspacing="0">
                    <col class="TableStyle-ref_2_col_table-Column-Column1" style="width: 240px;"/>
                    <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Column Name</th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Name</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Name of the available Java object (Mbean) attribute.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">Value</td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Value of the available Java object (Mbean) attribute.</td>
                        </tr>
                    </tbody>
                </table>
                
</div>

### VMX Artemis Cache

This sampler provides a list of your available VMX Artemis Cache metrics.

![VMX Artemis Cache](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-tr-artemis-cache-dataview.png)

<div class="table-container">
<table class="legacy-table" style="width: 100%;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" class="TableStyle-ref_2_col_table" cellspacing="0">
                    <col class="TableStyle-ref_2_col_table-Column-Column1" style="width: 240px;"/>
                    <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Column Name</th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Name</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Name of the available Java object (Mbean) attribute.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">Value</td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Value of the available Java object (Mbean) attribute.</td>
                        </tr>
                    </tbody>
                </table>
                
</div>

### VMX HeapMem

This sampler provides a list of your available VMX HeapMem metrics.

![VMX HeapMem](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-tr-artemis-heapmem-dataview.png)

<div class="table-container">
<table class="legacy-table" style="width: 100%;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" class="TableStyle-ref_2_col_table" cellspacing="0">
                    <col class="TableStyle-ref_2_col_table-Column-Column1" style="width: 240px;"/>
                    <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Column Name</th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Name</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Name of the available Java object (Mbean) attribute.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">Value</td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Value of the available Java object (Mbean) attribute.</td>
                        </tr>
                    </tbody>
                </table>
                
</div>

### VMX NonHeapMem

This sampler provides a list of your available VMX NonHeapMem metrics.

![VMX NonHeapMem](https://docscdn.itrsgroup.com/geneos/images/integrations/vmx-tr-artemis-nonheapmem-dataview.png)

<div class="table-container">
<table class="legacy-table" style="width: 100%;margin-left: 0;margin-right: auto;mc-table-style: url('../Resources/TableStyles/ref_2_col_table.css');" class="TableStyle-ref_2_col_table" cellspacing="0">
                    <col class="TableStyle-ref_2_col_table-Column-Column1" style="width: 240px;"/>
                    <col class="TableStyle-ref_2_col_table-Column-Column1"/>
                    <thead>
                        <tr class="TableStyle-ref_2_col_table-Head-Header1">
                            <th class="TableStyle-ref_2_col_table-HeadE-Column1-Header1">Column Name</th>
                            <th class="TableStyle-ref_2_col_table-HeadD-Column1-Header1">Description</th>
                        </tr>
                    </thead>
                    <tbody>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyE-Column1-Body1">Name</td>
                            <td class="TableStyle-ref_2_col_table-BodyD-Column1-Body1">Name of the available Java object (Mbean) attribute.</td>
                        </tr>
                        <tr class="TableStyle-ref_2_col_table-Body-Body1">
                            <td class="TableStyle-ref_2_col_table-BodyB-Column1-Body1">Value</td>
                            <td class="TableStyle-ref_2_col_table-BodyA-Column1-Body1">Value of the available Java object (Mbean) attribute.</td>
                        </tr>
                    </tbody>
                </table>
                
</div>