DataBot User Manual

Internal

os-stats

Overview

A low-overhead O/S level event collector that generates events-compatible events. It is designed to run in background, collect times events and channel them (to files, over the network, etc.) It is capable of collecting memory, CPU, etc. usage statistics, as well as WildFly management domain model and JMX metrics.

Installation

Download the stable release from

https://github.com/NovaOrdis/os-stats/releases

The release consists in a ZIP file with a name matching "os-stats-<version>.zip".

Unzip the release file in a conventional binary directory, such as /opt or /usr/local. An "os-stats-<version>" sub-directory will be created.

Add .../os-stats-<version>/bin to PATH.

os-stats needs a Java VM to run. It will attempt to locate one in this order:

1. Value of "OS_STATS_JAVA_HOME" environment variable, if set.
2. Value of "JAVA_HOME" environment variable, if set.
3. The "java" executable found in path.

Choose a directory to store the configuration file. If the configuration will be shared by multiple users and there will be used by just one os-stats instance on the system, we recommend /etc/os-stats. Otherwise, each user could maintain an individual configuration file in ~/.os-stats (recommended) or a directory of their choosing. The location of the configuration file should be exposed as the value of the OS_STATS_CONF environment variable in the environment of the user who will execute os-stats. If no OS_STATS_CONF environment variable is defined, os-stats will attempt to read ~/.os-stats/os-stats.yaml. Regardless of how the configuration file is declared, os-stats will fail if the file is not found. For details on the configuration file syntax see Configuration section below.

Complete any of target-specific configuration procedures, if they apply.

In-Line Help

os-stats --help

Configuration

Example

#
# os-stats configuration file
#

#
# sampling interval (in seconds)
#
sampling.interval: 20

#
# output configuration
#
output:
  file: /home/vagrant/tmp/os-stats.csv
  append: true

#
# metrics
#
metrics:

Metric Reference

os-stats Metric Reference