![Abstract composition of orange triangles and scattered points on white background (no text or symbols)](.vortex-opensplice-node-monitor-user-guide/1f6093763bca787644a35ef96d8d4f5f5bb4e23bcb26a71d6b0894d6f79d9d52.jpg)

# VORTEX

# OPENSPLICE

# Node Monitor User Guide

# Release 6.x

# Contents

# 1 Preface 1

1.1 About the Vortex OpenSplice Node Monitor User Guide . .
1.2 Conventions

# 2 Introduction 2

2.1 Supported Platforms 2

# 3 Starting and Stopping Node Monitor 3

3.1 Linux 3
3.2 Windows 3

# 4 Configuring Node Monitor 4

4.1 Setting up the configuration file 4
4.2 Default configuration file (application.conf) . 4

# 5 Data Available through Node Monitor 6

5.1 CPU Information 6
5.2 Operating System Information 6
5.3 Network Information 6
5.4 Network Interface Information . 6
5.5 Process Information 7
5.6 Network Interface Statistics 7
5.7 Memory Statistics 7
5.8 CPU statistics . 7
5.9 Process Memory Statistics: . 8
5.10 Process CPU Statistics 8

# 6 References 9

# 7 Contacts & Notices 10

7.1 Contacts 10
7.2 Notices 10

# 1

# Preface

# 1.1 About the Vortex OpenSplice Node Monitor User Guide

The Vortex OpenSplice Node Monitor User Guide provides the information needed by anyone who wants to monitor the statistics about the performance of a system.

This Guide contains:

• a list of supported platforms
• instructions for starting and stopping the Node Monitor
• descriptions of the Node Monitor configuration options
• a categorized list of the types of data that can be accessed with the Node Monitor

# 1.2 Conventions

The icons shown below are used in the Vortex product documentation to help readers to quickly identify information relevant to their specific use of OpenSplice.

<table><tr><td>Icon</td><td>Meaning</td></tr><tr><td></td><td>Item of special significance or where caution needs to be taken.</td></tr><tr><td></td><td>Item contains helpful hint or special information.</td></tr><tr><td></td><td>Information applies to Windows (e.g. XP, 2003, Windows 7) only.</td></tr><tr><td></td><td>Information applies to Unix-based systems (e.g. Solaris) only.</td></tr><tr><td></td><td>Information applies to Linux-based systems (e.g. Ubuntu) only.</td></tr><tr><td></td><td>C language specific.</td></tr><tr><td></td><td>C++ language specific.</td></tr><tr><td></td><td>C# language specific.</td></tr><tr><td></td><td>Java language specific.</td></tr></table>

# 2

# Introduction

Node Monitor is a Vortex OpenSplice application implemented in the Java language which is installed as part of Vortex OpenSplice.

It is possible to use Node Monitor on platforms where both Vortex OpenSplice and the Sigar API can be installed. See Supported Platforms below for detailed information.

Node Monitor publishes the following system-monitoring data into the OpenSplice backbone:

• CPU information and statistics
• Memory statistics
• Network interface information and statistics
• Operating System information
• Process information and statistics

Refer to Data Available through Node Monitor for complete list of data that can be obtained from Node Monitor.

# 2.1 Supported Platforms

• x86 / Linux kernel 2.6 and up (32/64-bit)
• x86 / Microsoft Windows 2003 Server/XP/7 (32/64-bit)

# 3

# Starting and Stopping Node Monitor

The Vortex OpenSplice environment must be set up correctly before starting the Node Monitor. Please refer to the Vortex OpenSplice Getting Started Guide for detailed information about how to install and configure Vortex OpenSplice.

# 3.1 Linux

Source the release.com file from the shell command line to set up the Vortex OpenSplice environment.

To start Node Monitor, enter the following command in the shell:

# Linux

> ./nodemon

# 3.2 Windows

To start Node Monitor, open an Vortex OpenSplice Command Prompt and enter the following command:

# Windows

> nodemon.bat

# 4

# Configuring Node Monitor

# 4.1 Setting up the configuration file

It is possible to control the frequency of the information and metrics that are pushed to the Vortex OpenSplice backbone. Setting the interval to -1 for a specific category will disable the push of monitoring data for that category.

To override the default configuration, create your own application.conf file in the same directory where you start the Node Monitor.

# 4.1.1 Configuration parameters

<table><tr><td>domain</td><td>Domain ID of the OpenSplice system.</td></tr><tr><td>partition</td><td>Partition name to which monitoring data will be published. Default is NODE_INFO. Do not change this when using with Vortex Insight!</td></tr><tr><td>historyDepth</td><td>History depth for HistoryQosPolicy. -1 to keep all history.</td></tr><tr><td>cpuInfo</td><td>CPU information interval in milliseconds. -1 to disable.</td></tr><tr><td>cpuStats</td><td>CPU statistics interval in milliseconds. -1 to disable.</td></tr><tr><td>memStats</td><td>Memory statistics interval in milliseconds. -1 to disable.</td></tr><tr><td>netInfo</td><td>Memory statistics interval in milliseconds. -1 to disable.</td></tr><tr><td>netInterfaceIn</td><td>Network interface information interval in milliseconds. -1 to disable.</td></tr><tr><td>netInterfaceSt</td><td>Network interface statistics interval in milliseconds. -1 to disable.</td></tr><tr><td>operatingSystem</td><td>Operating system information interval in milliseconds. -1 to disable.</td></tr><tr><td>processInfo</td><td>Process information interval in milliseconds. -1 to disable.</td></tr><tr><td>processCPUStat</td><td>Process CPU statistics interval in milliseconds. -1 to disable.</td></tr><tr><td>processMemorySt</td><td>Process memory statistics interval in milliseconds. -1 to disable.</td></tr></table>

# 4.2 Default configuration file (application.conf)

```hcl
# define default scope variables to be used for setting the value of other parameters.
default {
    domain = 0
    partition = NODE_INFO
    historyDepth = 10
    interval {
    information = 60000
    statistics = 2000
    }
}
opensplice {
    hm {
    nodeinfoservice{
```

```txt
domain = ${default.domain}
partition = ${default.partition}
historyDepth = ${default.historyDepth}
interval {
    cpuInfo = ${default.interval.information}
    cpuStats = ${default.interval.statistics}
    memStats = ${default.interval.statistics}
    netInfo = ${default.interval.information}
    netInterfaceInfo = ${default.interval.information}
    netInterfaceStats = ${default.interval.statistics}
    operatingSystemInfo = ${default.interval.information}
    processCPUStats = ${default.interval.statistics}
    processInfo = ${default.interval.information}
    processMemoryStats = ${default.interval.statistics}
}
}
```

# 5

# Data Available through Node Monitor

# 5.1 CPU Information

• Vendor
• CPU Model
• CPU Frequency
• Cache size
• Number of cores on the CPU

# 5.2 Operating System Information

• OS name
• Distribution name (e.g. Ubuntu 12.04)
• Architecture of the OS
• Linux kernel image version
• Vendor and vendor version
• Data model (32/64 bit etc.)
• Endianness

# 5.3 Network Information

• Primary interface primary address primary MAC address and primary netmask
• Domain name
• Default gateway default gateway interface
• Primary DNS and secondary DNS

# 5.4 Network Interface Information

• Interface name
• Interface type (e.g. Ethernet Loopback)
• MAC address
• Destination

• Broadcast
• Netmask
• MTU

# 5.5 Process Information

• Process ID
• Name
• Current working directory
• Priority
• Number of threads in the process
• OSPL environment variables (e.g. OSPL\_URI, OSPL\_HOME, etc.)

# 5.6 Network Interface Statistics

• RX values: bytes packets errors dropped overruns and frame
• TX values: bytes packets errors dropped overruns collisions and carrier

# 5.7 Memory Statistics

• Total system memory
• Total used system memory
• Total free system memory
• Actual total used system memory
• Actual total free system memory
• Total swap size
• Total used swap size
• Total free swap size
• RAM size in MB

# 5.8 CPU statistics

• Load and load average
• Total number of processes in idle state
• Total number of processes in running state
• Total number of processes in sleeping state
• Total number of zombie processes
• Total number of processes
• Total number of threads

# 5.9 Process Memory Statistics:

• Process ID
• Resident memory size used in Bytes
• Shared memory size used in Bytes
• Number of minor page faults
• Number of major page faults
• Total number of page faults (Major + Minor)
• Virtual memory size used in Bytes

# 5.10 Process CPU Statistics

• Process ID
• Percent CPU used
• Start time in milliseconds (Epoch time)
• Total CPU time in milliseconds (User + System)
• User CPU time in milliseconds
• System CPU time in milliseconds

<table><tr><td>data[5].switch</td><td colspan="2">PROCESS_CPU_STATS</td></tr><tr><td>data[5].processCPUStats.procld</td><td colspan="2">15927</td></tr><tr><td>data[5].processCPUStats.percent</td><td colspan="2">0.024975024975025</td></tr><tr><td>data[5].processCPUStats.startTime</td><td colspan="2">1402582003000</td></tr><tr><td>data[5].processCPUStats.totalCPUTime</td><td colspan="2">17220</td></tr><tr><td>data[5].processCPUStats.userCPUTime</td><td colspan="2">13060</td></tr><tr><td>data[5].processCPUStats.sysCPUTime</td><td colspan="2">4160</td></tr><tr><td>data[6].switch</td><td colspan="2">PROCESS_MEM_STATS</td></tr><tr><td>data[6].processMemStats.procld</td><td colspan="2">15969</td></tr><tr><td>data[6].processMemStats.resident</td><td colspan="2">60477440</td></tr><tr><td>data[6].processMemStats.share</td><td>15241216</td><td>15969</td></tr><tr><td>data[6].processMemStats.minorFaults</td><td colspan="2">19708</td></tr><tr><td>data[6].processMemStats.majorFaults</td><td colspan="2">46</td></tr><tr><td>data[6].processMemStats.pageFaults</td><td colspan="2">19754</td></tr><tr><td>data[6].processMemStats.size</td><td colspan="2">1793462272</td></tr></table>

Figure 5.1: Example Process Memory & CPU statistics

# 6

# References

# Sigar API

https://github.com/hyperic/sigar

# 7

# Contacts & Notices

# 7.1 Contacts

# ADLINK Technology Corporation

400 TradeCenter

Suite 5900

Woburn, MA

01801

USA

Tel: +1 781 569 5819

# ADLINK Technology Limited

The Edge

5th Avenue

Team Valley

Gateshead

NE11 0XA

UK

Tel: +44 (0)191 497 9900

# ADLINK Technology SARL

28 rue Jean Rostand

91400 Orsay

France

Tel: +33 (1) 69 015354

Web: http://ist.adlinktech.com/

Contact: http://ist.adlinktech.com

E-mail: ist\_info@adlinktech.com

LinkedIn: https://www.linkedin.com/company/79111/

Twitter: https://twitter.com/ADLINKTech\_usa

Facebook: https://www.facebook.com/ADLINKTECH

# 7.2 Notices

Copyright © 2018 ADLINK Technology Limited. All rights reserved.

This document may be reproduced in whole but not in part. The information contained in this document is subject to change without notice and is made available in good faith without liability on the part of ADLINK Technology Limited. All trademarks acknowledged.
[🔗 Link to the original document](.vortex-opensplice-node-monitor-user-guide/vortex-opensplice-node-monitor-user-guide.pdf)