OpenConfig Telemetry

OpenConfig is an open-source initiative by network operators to develop vendor-neutral data models, programmatic interfaces, and tools for managing networks.

The OpenConfig client lets you stream OpenConfig telemetry data over gRPC to Horizon. Some vendors currently using OpenConfig telemetry include Juniper, Arista, and Cisco.

To enable support for OpenConfig, edit ${OPENNMS_HOME}/etc/telemetryd-configuration.xml set enabled=true for the OpenConfig protocol.

Enable OpenConfig protocol in telemetryd-configuration.xml

<!-- OpenConfig -->
    <connector name="OpenConfig-Connector"
               class-name="org.opennms.netmgt.telemetry.protocols.openconfig.connector.OpenConfigConnector"
               service-name="OpenConfig"
               queue="OpenConfig"
               enabled="true">
        <package name="OpenConfig-Default">
            <filter>IPADDR != '0.0.0.0'</filter>
            <parameter key="port" value="${requisition:oc.port|9000}"/>
            <parameter key="paths" value="/network-instances/network-instance[instance-name=master]"/>
         </package>
    </connector>

    <queue name="OpenConfig">
        <adapter name="OpenConfig-Adapter" class-name="org.opennms.netmgt.telemetry.protocols.openconfig.adapter.OpenConfigAdapter" enabled="true">
            <parameter key="script" value="${install.dir}/etc/telemetryd-adapters/openconfig-telemetry-resources.groovy"/>
            <package name="OpenConfig-Default">
                <rrd step="300">
                    <rra>RRA:AVERAGE:0.5:1:2016</rra>
                    <rra>RRA:AVERAGE:0.5:12:1488</rra>
                    <rra>RRA:AVERAGE:0.5:288:366</rra>
                    <rra>RRA:MAX:0.5:288:366</rra>
                    <rra>RRA:MIN:0.5:288:366</rra>
                </rrd>
            </package>
        </adapter>
    </queue>

Apply the changes without restarting by sending a reloadDaemonConfig event in the CLI or the Web UI:

Send a reloadDaemonConfig event through CLI

$\{OPENNMS_HOME}bin/send-event.pl -p 'daemonName Telemetryd' uei.opennms.org/internal/reloadDaemonConfig

OpenConfig Connector

OpenConfig Connector initiates a connection with an agent via gRPC and subscribes to one or more OpenConfig data paths (strings), then collects and forwards the data to a queue. The data contains metadata and is structured as a list of key:value pairs.

Horizon creates a new connector for each agent it is responsible for connecting to.

Connector Config

    <connector name="OpenConfig-Connector"
               class-name="org.opennms.netmgt.telemetry.protocols.openconfig.connector.OpenConfigConnector"
               service-name="OpenConfig"
               queue="OpenConfig"
               enabled="true">
        <package name="OpenConfig-Default">
            <filter>IPADDR != '0.0.0.0'</filter>
            <parameter key="port" value="${requisition:oc.port|9000}"/>
            <parameter key="retries" value="12"/>
            <parameter key="interval" value="300"/>
            <parameter key="tls.enabled" value="${requisition:oc.tls.enabled}"/>
            <parameter key="tls.trust.cert.path" value="${requisition:trust.cert.path}"/>
           <!-- Use groups to separate paths that need to be streamed at different frequencies -->
            <parameter group="group1" key="paths" value="/network-instances/network-instance[instance-name=master]"/>
            <parameter group="group1" key="frequency" value="5000"/>
            <parameter group="group2" key="paths" value="/protocols/protocol/bgp"/>
            <parameter group="group2" key="frequency" value="30000"/>
            <parameter group="group3" key="paths" value="/interfaces/interface[name=Ethernet1][ifIndex=25]/state/counters"/>
            <parameter group="group3" key="frequency" value="60000"/>
        </package>
    </connector>

Packages

At least one package must be present for the connector to function. Use multiple packages to customize the parameter’s subsets of nodes.

The filter element is optional; if missing, all services with the given name will be considered.

Use the group element to group parameters into multiple groups when you need to stream different paths at different frequencies. Global parameters like port, and connection-specific parameters, do not need any group.

Parameters are passed to the connector and are interpolated for node/interface and service-level metadata.

Table 1. Connector-specific parameters for the OpenConfigConnector
Parameter	Description	Required	Default value
`port`	Port that OpenConfig client can connect to	required	(none)
`paths`	Paths that need to be subscribed to	required	(empty)
`frequency`	Frequency at which OpenConfig data can be streamed	required	(300000)(5mins)
`retries`	Number of retries to attempt to make a connection when failed	optional	(0)(unlimited)
`interval`	Interval at which client tries to make a connection when failed	optional	(300)(5mins)
`tls.enabled`	Enable TLS authentication	optional	false
`tls.trust.cert.path`	Server trust certificate path	optional	(none)

OpenConfig Adapter

The OpenConfig adapter handles OpenConfig payloads. Messages are decoded and forwarded to a JSR-223 compatible script (e.g., BeanShell or Groovy) for further processing. Use the script extension to extract the desired metrics from the OpenConfig stream data and persist the results as time series data.

Facts

Class Name

org.opennms.netmgt.telemetry.protocols.openconfig.adapter.OpenConfigAdapter

Parameters

Table 2. Adapter-specific parameters for the OpenConfigAdapter
Parameter	Description	Required	Default value
`script`	Full path to the script that handles the OpenConfig data	required	(none)
`mode`	Specify mode for stream format, gNMI or JTI	optional	gnmi

Scripting

The script will be invoked for every OpenConfig stream data that is received and succesfully decoded.

The following globals will be passed to the script:

Table 3. Globals passed to the script for gNMI (default) mode.
Parameter	Description	Type
`agent`	The agent (node) against which the metrics will be associated	`org.opennms.netmgt.collection.api.CollectionAgent`
`builder`	Builder in which the resources and metrics should be added	`org.opennms.netmgt.collection.support.builder.CollectionSetBuilder`
`msg`	Decoded message from which the metrics should be extracted	`org.opennms.features.openconfig.proto.gnmi.Gnmi.SubscribeResponse`

Table 4. Globals passed to the script for JTI mode.
Parameter	Description	Type
`agent`	The agent (node) against which the metrics will be associated	`org.opennms.netmgt.collection.api.CollectionAgent`
`builder`	Builder in which the resources and metrics should be added	`org.opennms.netmgt.collection.support.builder.CollectionSetBuilder`
`msg`	Decoded message from which the metrics should be extracted	`org.opennms.features.openconfig.proto.jti.Telemetry.OpenConfigData`

The OpenConfig protocol is not supported on Minion.