Performance datasource

Used to extract data points from time series data that OpenNMS collects and stores. The query is used to identify which attribute(s) (or series) are being queried.

Resource and Attribute fields allow * and | filter characters to create search patterns that allow you to retrieve multiple resources and attributes in a single query.

Examples:

Given the following list of resources, the table below shows an example of filter expressions.

Used to read the last value of string-valued properties that OpenNMS collects and stores. The query identifies which string property is queried. A panel can contain multiple string property queries. The result can be visualized in a table. Use Grafana’s transforms like "Filter by name", "Organize Fields", or "Merge" to adjust the visualized table as needed.

Used to combine or otherwise transform one or more series into a new series. Supports mathematical and conditional operators provided by JEXL. Consult the Measurements API documentation of your OpenNMS version for more details.

Used to create new and/or alter existing series.

The option provided depend on the selected filter.

The locations() query returns a list of all available node locations. Use this inside nodeFilter() to filter the number of nodes displayed by location.

The nodeFilter() query returns a list of nodes which match the given filter expression.

The available arguments are as follows:

The nodeResources() query will return the list of resource IDs which are available on the given node. An optional second argument specifies whether to show the resource’s ID (the default), label, or name in the template value chooser and elsewhere. An optional third argument specifies an exact resource-type name (e.g. interfaceSnmp); a value of * makes explicit the default behavior of returning resources of all types. Regular expressions in the template query can then be used to filter which resource IDs are used.

To query a specific node by ID, you can use an expression similar to:

To query a specific node by foreign source and foreign id, you can use an expression similar to:

To query only SNMP interface resources on the node with ID 42, and to display the interface’s resource labels rather than their often-cryptic IDs, you might use:

To query all resources on the node with ID 42, and labels that match the regular expression *.DPN.*, you might use:

The available arguments are as follows:

The nodeToLabel() function will be replaced with the label of the node specified.

You can pass either a node ID or foreign-source:foreign-id tuple. It is also possible to use a template variable based on a custom list of node identifiers or the results of a nodeFilter() query.

To use a template variable representing nodes, just pass it, like so:

To manually specify by ID or node criteria, just pass them in raw:

The resourceToLabel() function converts an OpenNMS resource identifier or node criteria and partial identifier into the resource’s label. The format of the resource label depends on the resource, and can be anything from a node label, to a descriptive string for an IP interface.

The 1-argument form of this call expects a complete resource ID. That resource ID must be the full resource identifier as queried to the measurements API.

The 2-argument form of this call lets you use template variables to choose a node and then separately provide the remainder of the resource ID you want to translate.

A partial resource ID is just the portion of the resource identifier that doesn’t identify the node itself, like nodeSnmp[] or responseTime[127.0.0.1].

For example, both of these resourceToLabel calls would be translated into the same text:

The resourceToName() function behaves exactly like the resourceToLabel() function, only it returns the resource’s name, rather than its label. The resource name is usually the internal, machine-readable name of the resource, like a node criteria, or an interface name + MAC address.

Finally, just like resourceToLabel() and resourceToName(), resourceToInterface() transforms a resource ID or combination node criteria and partial resource ID into another value.

It is a special case of the other more general methods that will take the label of the resource (assumed to be an interface-MAC formatted string) and just return the interface portion.