OpenNMS Time Series DB

The OpenNMS Time Series DB provides a scalable cloud-hosted time series database to store and persist performance metrics that Horizon collects from the devices it monitors. In addition, users can view time series summary data including health status, capacity, and metrics per second in the OpenNMS Portal.

Requirements

You must have the following to use the Time Series DB:

  • Horizon 31+ (Meridian availability with the 2023 release).

  • Time Series DB subscription that provides access to the OpenNMS Portal to retrieve your activation key and view Time Series DB metrics.

Contact sales@opennms.com to sign up for the Time Series DB.

Deployment

There are three phases of deployment to set up the Time Series DB for your system:

  • Update OpenNMS Cloud Services Connector files.

  • Obtain an activation key for the Cloud Services Connector.

  • Enable cloud services connectivity.

Update OpenNMS Cloud Services Connector files

The OpenNMS Cloud Services Connector is an extension that lets a Horizon instance send time series data to an OpenNMS-hosted cloud service.

This extension is installed by default in Horizon 31. However, you need to move the configuration files into the correct location and restart Horizon as part of the Time Series DB setup process:

cp /opt/opennms/etc/examples/opennms.properties.d/timeseries.properties /opt/opennms/etc/opennms.properties.d/timeseries.properties

systemctl restart openmns

Obtain an activation key

The activation key lets Horizon connect with OpenNMS cloud services (currently the Time Series DB).

You must log in to the OpenNMS Portal to get this activation key, copy it, and then paste it into the appropriate screen in Horizon.

When you signed up for the Time Series DB, you received an activation email from OpenNMS with a login for the OpenNMS Portal.

To obtain the activation key, follow these steps:

  1. If you have not already done so, activate your OpenNMS Portal account by clicking the Account Activation button in your welcome email.

  2. On the Create Your OpenNMS Account screen, type a password in the Password box and click Create My Account.

  3. Sign in to the OpenNMS Portal with your username and password.

  4. Choose OpenNMS Core Instances in the left menu and click Add New.

  5. Type in the name of your instance and click Generate Activation Key.

  6. Copy the activation key and click Save & Close.

    The key is valid for one hour. If you do not use it within that time, you must log back into the OpenNMS Portal, delete the old instance, create a new one, and generate a new key.
  7. Log in to the OpenNMS Horizon web UI for your instance.

  8. Click Plugins  Cloud Services in the top menu bar.

  9. Turn the Cloud Services Deactivate toggle to on.

  10. Paste the key in the Enter Activation Key box and click Activate.

By default, collectd collects data every five minutes. You should see time series summary information in the OpenNMS Portal UI within 15 minutes. For more information on how to view this information, see View Time Series Summary Data. To change the data collection frequency, see Service configuration attributes.

Troubleshooting

To verify that your Time Series DB is set up correctly, run the health-check command in Karaf. You should see something like the following:

admin@opennms()> health-check
Verifying the health of the container

Verifying installed bundles                    [ Success  ]
Cloud status                                   [ Success  ] => Cloud status=SERVING
Connecting to ElasticSearch ReST API (Flows)   [ Success  ] => Not configured

=> Everything is awesome

Check Karaf logs if the registration fails or the health check does not say SERVING. If this is the case, you will need to open a support ticket.

You can also check that OPENNMS_HOME/share/rrd files are still being updated. If they are not, this indicates that the Time Series DB is not working.

View time series summary data

You can view time series summary data including health status, capacity, and metrics per second in the OpenNMS Portal. By default, the screen displays data for all OpenNMS instances you have configured to use the Time Series DB. You can filter to see data for a specific instance.

  1. Sign in to the OpenNMS Portal with your username and password.

  2. In the left menu, click Time Series.

  3. View the information.

  4. To see summary data for a specific instance, type an instance name in the Search Instances field.

    The screen updates to display only that instance and its associated summary data.