Categorygithub.com/opennetworkinglab/gnmi
module
0.0.0-20210226143612-aed1ee41fd31
Repository: https://github.com/opennetworkinglab/gnmi.git
Documentation: pkg.go.dev

# README

gNMI - gRPC Network Management Interface

This repository contains reference Go implementations for gNMI.

Note: This is not an official Google product.

The implementations include:

  • client library implementation using gnmi.proto
  • CLI for interacting with a gNMI service
  • Caching collector that connects to multiple gNMI targets and makes the data available over a single gNMI Subscribe RPC to clients

Installing

To install the CLI, run

go get -u github.com/openconfig/gnmi/cmd/gnmi_cli

Client libraries

The main entry point for using the client libraries is in github.com/openconfig/gnmi/client.

See godoc pages for documentation and usage examples.

# Packages

Package cache is a tree-based cache of timestamped state provided from one or more gNMI targets.
Package cli provides the query capabilities for streaming telemetry.
Package client provides a generic access layer for streaming telemetry providers.
No description provided by the author
Package coalesce provides an in-order queue for collecting outputs from a producer to provide inputs to a consumer.
Package collector provides a gRPC interface to reconnect targets in a gNMI collector.
Package connection manages cached client connections to gRPC servers.
Package ctree implements a Tree container whose methods are all thread-safe allowing concurrent access for multiple goroutines.
Package errdiff makes it easy to compare Error by code, substring or exact match in tests.
Package errlist implents an error type that contains a list of other errors.
Package manager provides functions to start or stop monitoring of a target.
Package match builds a tree of active subscriptions that is matched against all incoming updates.
Package metadata describes metadata paths stored in the cache per target.
Package path provides utility functions to convert a given gnmi.Path into index strings.
No description provided by the author
Package subscribe implements the gnmi.proto Subscribe service API.
Package target has utility functions for working with target configuration proto messages in target.proto.
No description provided by the author
Package value provides utility functions for working with gNMI TypedValue messages.
Package watch detects raw changes to files.