Plugins 〉OpenNMS Plugin for Grafana


Developer

The OpenNMS Group Inc.


Sign up to receive occasional product news and updates:



Application
community

OpenNMS Plugin for Grafana

  • Overview
  • Installation
  • Change log
  • Related content

OpenNMS Plugin for Grafana CircleCI

OpenNMS Plugin for Grafana (formerly known as Helm) is a Grafana application that allows users to create flexible monitoring dashboards using data from OpenNMS® Horizon™ and/or OpenNMS® Meridian™.

Supported data:

  • Performance and response time (time series metrics)
  • Fault (alarms and outages)
  • Inventory (nodes, IP & SNMP interfaces, services)
  • NetFlow (NetFlow v5 & v9, IPFIX, sFlow)

For help on installing, configuring, and using the application, read the documentation.

Features

Flexible data filtering

Isolate the data you want to display using custom filters and conditions. The filter panel goes a step further—enabling global data filtering for your dashboard.

Configurable displays

Present fields that are most relevant to you and your teams to improve tracking and triage.

Alarm interactions

Acknowledge, escalate, create, and clear tickets for alarms directly from the dashboard.

Storage engine agnostic

Retrieve time series metrics stored in persistence engines, including OpenNMS Time Series DB, Newts, Cortex, RRDtool, or JRobin.

Flows deep-dive dashboard

This custom dashboard, included in the app, provides a powerful, flexible interface for exploring NetFlow data alongside performance metrics.

Template support

Populate template variables with query results from any of the included OpenNMS data source plugins.

Trending and forecasting of time series data

Remove outliers and perform trending or forecasting using the built-in series filters or develop your own filters using Java or R. Derive new series using JEXL expressions.

Support Matrix

  • Performance data source
    • OpenNMS Horizon 16 or greater
    • OpenNMS Meridian 2016 or greater
  • Entities data source
    • Alarms
      • OpenNMS Horizon 20 or greater
      • OpenNMS Meridian 2018 or greater
    • IP and SNMP interfaces, outages, and services
      • OpenNMS Horizon 26 or greater
      • OpenNMS Meridian 2020 or greater
  • Flows data source
    • OpenNMS Horizon 24 or greater
    • OpenNMS Meridian 2019 or greater

This plugin requires Grafana 9 or greater.

Issue Tracking

We use the OpenNMS Plugin for Grafana project in our JIRA instance to track bugs and enhancements related this to project.

Changelog

The changelog has moved to CHANGELOG.md.

Installing OpenNMS Plugin for Grafana on Grafana Cloud:

For more information, visit the docs on plugin installation.

v9.0.14

Grafana Plugin for OpenNMS version 9.0.14 release contains a number of bug fixes and enhancements.

  • OPG-384 Add variables to node/resource drop down
  • OPG-471 Ensure that template variables are allowed in query editor fields
  • OPG-475 nodeResources query not working properly
  • OPG-477 Allow manual override UI and Docs updates after Grafana review
  • OPG-478 Alarm Table Panel Pagination not working correctly

v9.0.13

Grafana Plugin for OpenNMS version 9.0.13 release contains a bug fix.

  • OPG-475 nodeResources query not working properly

v9.0.12

Grafana Plugin for OpenNMS version 9.0.12 release is a re-release of 9.0.11 with minor fixes.

  • OPG-466 Unable to filter Alarm query by a multi-value node variable
  • OPG-474 Display notice after Alarm Panel action instead of refreshing panel

v9.0.11

Grafana Plugin for OpenNMS version 9.0.11 release contains a bug fix and enhancements.

  • OPG-468 Add `nodeId()` query to datasources
  • OPG-469 Alarm Panel Columns Resizing
  • OPG-470 Alarm Panel User Feedback
  • OPG-472 Documentation for OPG nodeFilter labelFormat and valueFormat

v9.0.10

Grafana Plugin for OpenNMS version 9.0.10 release contains a bug fix and an enhancement.

  • OPG-464 Node ID field missing from some Entity DS results
  • OPG-410 Add up/down status to Monitored Services entity

v9.0.9

Grafana Plugin for OpenNMS version 9.0.9 release contains a number of bug fixes and enhancements.

  • OPG-448 Converter outputs extra characters in resource name
  • OPG-454 Flow query with multi-value withHost does not return data
  • OPG-460 Entities DS - Nodes Table - Category Values showing under Primary SNMP ifIndex
  • OPG-461 Entity datasource no longer includes node ID / node label in IP interface query results
  • OPG-463 Entitles DS Tables Limit does not allow a value of zero

v9.0.8

Grafana Plugin for OpenNMS version 9.0.8 is a re-release of version 9.0.7 which contains a number of bug fixes and enhancements.

  • OPG-369 React Flow Panel and Datasource improvements
  • OPG-427 Node metadata not always returned
  • OPG-438 v9 Dashboard Converter tool is resetting query datasources to default names

v9.0.7

Grafana Plugin for OpenNMS version 9.0.7 release contains a number of bug fixes and enhancements.

  • OPG-369 React Flow Panel and Datasource improvements
  • OPG-427 Node metadata not always returned
  • OPG-438 v9 Dashboard Converter tool is resetting query datasources to default names

v9.0.6

Grafana Plugin for OpenNMS version 9.0.6 release contains a number of bug fixes and enhancements.

  • HELM-446 Stat Panel "Last *" Calculation doesn't ignore NaN values
  • HELM-445 upgrade helm to latest grafana 9.x APIs
  • HELM-443 Site documentation not building
  • HELM-442 Regression: Unable to manually type in node value in Perf DS
  • HELM-440 Dashboard converter does not update Entity Alarm queries properly
  • HELM-439 Filter panel field order does not adapt to panel shape
  • HELM-435 Entity DS Alarm query doesn't handle multi value variables properly
  • HELM-430 Perf DS Query doesn't support ${variable} syntax
  • HELM-418 Document that variables must now be defined prior to use in expressions
  • HELM-416 Docs about Predefined Dashboards are misleading
  • HELM-415 Docs direct user to create a Custom Action when creating a Dashboard but this feature no longer exists in Grafana v9

v9.0.5

Grafana Plugin for OpenNMS version 9.0.5 is a small release with a number of small fixes and enhancements.

  • HELM-432 Create a Converter Dashboard
  • HELM-425 Fix logic for transient flag
  • HELM-424 Unable to set node in Perf DS Query
  • HELM-422 Default flow dashboards need updating for v9 plugin
  • HELM-417 Resource field hard-coding node ID
  • HELM-414 Converted dashboards that use expressions fail because attribute labels are misplaced after conversion
  • HELM-400 Alarm Table details does not show Alarm ID
  • HELM-396 Alarm Table - allow right-click anywhere in panel
  • HELM-389 Filter Panel: Tie to Dashboard

v9.0.4

Grafana Plugin for OpenNMS version 9.0.4 is a small release with one bugfix.

  • HELM-421: PerfDS: Explorer for string property gives error "N.replace is not a function"

v9.0.3

Grafana Plugin for OpenNMS version 9.0.3 is a small release with one final breaking ID change based on Grafana's registry guidelines.

It contains a number of dependency security updates, as well as a few small bugfixes:

  • HELM-398: Alarm Table / Entity Datasource: Enable "Use Grafana User"
  • HELM-406: Adding a perf filter query to a dashboard elicits "TypeError: l is undefined"
  • HELM-411: Alarm datasource query not keeping proper equality

v9.0.2

Grafana Plugin for OpenNMS version 9.0.2 is a bugfix release.

v9.0.1

Grafana Plugin for OpenNMS version 9.0.1 is a re-release of 9.0.0, with a change to the plugin ID used for publication to Grafana's registry and updated logo.

v9.0.0

Grafana Plugin for OpenNMS version 9 is a large refactor of the codebase from Helm 8.

Highlights include:

  • rewrite all panels in React
  • clean up a bunch of code under the covers to use newer Grafana datastructures
  • lots of documentation updates and improvements
  • and much, much more!

A Dashboard Convert Panel has been provided to migrate your dashboards from Helm 8. Instructions on backing up your existing dashboards and upgrading can be found in the Grafana plugin documentation.