RRD/JRB to Newts Migration Utility

Use this utility to migrate existing RRDtool- or JRobin-based data to a Newts cluster. The migration process traverses the ${OPENNMS_HOME}/share/rrd directory and its subdirectories, reads the data and properties files, and persists this data to Newts.

Migration

The following suggestions try to minimize the data collection gap that occurs when reconfiguring Horizon for a different storage strategy:

  1. Determine the parameters needed to migrate your existing data.

  2. Reconfigure Horizon to persist all new collected data to Newts storage.

  3. Use the newts-repository-converter utility to convert and persist the RRD- or JRobin-based data to Newts.

Prerequisites

To complete this migration, you must have the following:

  • Working Horizon installation.

  • Previously configured RRDTool- or JRobin-based storage strategy.

  • Installed and configured Newts cluster that your Horizon instance can reach.

Migration plan

Follow the steps below to migrate your data to Newts:

  1. Verify and write down the values for the following properties in opennms.properties. You will need this information later to invoke the newts-repository-converter utility.

    1. ${OPENNMS_HOME}/etc/opennms.properties:

      • In org.opennms.rrd.storeByGroup, enable storeByGroup.

      • In rrd.base.dir, check for the location where RRD or JRB files are stored.

      • In rrd.binary, check for the location of the RRDTool binary.

    2. ${OPENNMS_HOME}/etc/rrd-configuration.properties:

      • In org.opennms.rrd.strategyClass, check if you are using JRobin (JRobinRrdStrategy or JniRrdStrategy) or RRDTool (MultithreadedJniRrdStrategy).

  2. Stop Horizon.

  3. Reconfigure Horizon settings to persist data to Newts. When properly configured, all new samples will be persisted to Newts after Horizon starts. Note that the converter assumes storeByForeignSource is enabled.

  4. Start Horizon.

  5. Use newts-repository-converter to convert your existing data to Newts by specifying the options that correspond to the information that you gathered previously.

This procedure minimizes the data collection gap to the time needed to reconfigure Horizon for Newts storage.

The newts-repository-converter utility needs the path to the base directory of your Horizon instance to read the configuration files. For example, the utility needs the datasource configuration during the migration process to query the database to look up node data.

Use

The utility is installed by default and its wrapper script is located in the ${OPENNMS_HOME}/bin directory:

$ cd ${OPENNMS_HOME}/bin
$ ./newts-repository-converter
When invoked without parameters, the usage and help information is printed.

The newts-repository-converter tool accepts the following parameters:

Required and optional newts-repository-converter parameters
Short Option Long Option Description Default

Required

t

rrd-tool

Whether RRDtool or JRobin was used prior to Newts. Available options:
rrdtool | rrd | true
jrobin | jrb | false

s

store-by-group

Whether store by group was enabled prior to Newts. Available options:
storeByMetric | sbm | false
storeByGroup | sbg | true

Optional

h

help

Prints help and use information.

Empty

o

onms-home

Horizon home directory.

${OPENNMS_HOME}

r

rrd-dir

The path to the RRD data.

${OPENNMS_HOME}/share/rrd

T

rrd-binary

The binary path to the rrdtool command (used only if rrd-tool is set).

/usr/bin/rrdtool

n

threads

Number of conversion threads.

Defaults to number of CPUs

Example 1: Convert RRD-based data with storeByGroup enabled

The following example shows how to convert RRDTool-based data that was stored with storeByGroup enabled. The default Horizon home and data directories are used and the RRDTool binary at /usr/local/bin/rrdtool is used. This program call uses 16 concurrent threads to convert the RRD files.

$ ./newts-repository-converter -t true -s true -T /usr/local/bin/rrdtool -n 16

Example 2: Convert JRobin-based data with storeByGroup disabled

The following example shows how to convert JRobin-based data located in the directory /mnt/opennms/rrd that was collected with storeByGroup disabled. This program call uses eight concurrent threads to convert the JRB files.

$ ./newts-repository-converter -t false -s false -r /mnt/opennms/rrd -n 8