ciscotelemetrymdt

README

Cisco Model-Driven Telemetry (MDT) Input Plugin

Cisco model-driven telemetry (MDT) is an input plugin that consumes telemetry data from Cisco IOS XR, IOS XE and NX-OS platforms. It supports TCP & GRPC dialout transports. GRPC-based transport can utilize TLS for authentication and encryption. Telemetry data is expected to be GPB-KV (self-describing-gpb) encoded.

The GRPC dialout transport is supported on various IOS XR (64-bit) 6.1.x and later, IOS XE 16.10 and later, as well as NX-OS 7.x and later platforms.

The TCP dialout transport is supported on IOS XR (32-bit and 64-bit) 6.1.x and later.

Configuration

[[inputs.cisco_telemetry_mdt]]
  instance_id = "" # unique instance identifier (REQUIRED)

  ## Telemetry transport can be "tcp" or "grpc".  TLS is only supported when
  ## using the grpc transport.
  transport = "grpc"

  ## Address and port to host telemetry listener
  service_address = ":57000"

  ## Enable TLS; grpc transport only.
  # tls_cert = "/etc/circonus-unified-agent/cert.pem"
  # tls_key = "/etc/circonus-unified-agent/key.pem"

  ## Enable TLS client authentication and define allowed CA certificates; grpc
  ##  transport only.
  # tls_allowed_cacerts = ["/etc/circonus-unified-agent/clientca.pem"]

  ## Define (for certain nested telemetry measurements with embedded tags) which fields are tags
  # embedded_tags = ["Cisco-IOS-XR-qos-ma-oper:qos/interface-table/interface/input/service-policy-names/service-policy-instance/statistics/class-stats/class-name"]

 ## Define aliases to map telemetry encoding paths to simple measurement names
 [inputs.cisco_telemetry_mdt.aliases]
   ifstats = "ietf-interfaces:interfaces-state/interface/statistics"

Example Output

ifstats,path=ietf-interfaces:interfaces-state/interface/statistics,host=linux,name=GigabitEthernet2,source=csr1kv,subscription=101 in-unicast-pkts=27i,in-multicast-pkts=0i,discontinuity-time="2019-05-23T07:40:23.000362+00:00",in-octets=5233i,in-errors=0i,out-multicast-pkts=0i,out-discards=0i,in-broadcast-pkts=0i,in-discards=0i,in-unknown-protos=0i,out-unicast-pkts=0i,out-broadcast-pkts=0i,out-octets=0i,out-errors=0i 1559150462624000000
ifstats,path=ietf-interfaces:interfaces-state/interface/statistics,host=linux,name=GigabitEthernet1,source=csr1kv,subscription=101 in-octets=3394770806i,in-broadcast-pkts=0i,in-multicast-pkts=0i,out-broadcast-pkts=0i,in-unknown-protos=0i,out-octets=350212i,in-unicast-pkts=9477273i,in-discards=0i,out-unicast-pkts=2726i,out-discards=0i,discontinuity-time="2019-05-23T07:40:23.000363+00:00",in-errors=30i,out-multicast-pkts=0i,out-errors=0i 1559150462624000000

Documentation

Index

• type CiscoTelemetryMDT
  • func (c *CiscoTelemetryMDT) Address() net.Addr
  • func (c *CiscoTelemetryMDT) Description() string
  • func (c *CiscoTelemetryMDT) Gather(_ context.Context, _ cua.Accumulator) error
  • func (c *CiscoTelemetryMDT) MdtDialout(stream dialout.GRPCMdtDialout_MdtDialoutServer) error
  • func (c *CiscoTelemetryMDT) SampleConfig() string
  • func (c *CiscoTelemetryMDT) Start(ctx context.Context, acc cua.Accumulator) error
  • func (c *CiscoTelemetryMDT) Stop()

Types

type CiscoTelemetryMDT

type CiscoTelemetryMDT struct {

	// not used but required for mdt_dialout pkg update
	dialout.UnimplementedGRPCMdtDialoutServer
	Log cua.Logger

	Aliases map[string]string `toml:"aliases"`

	Transport      string
	ServiceAddress string `toml:"service_address"`
	internaltls.ServerConfig
	EmbeddedTags []string `toml:"embedded_tags"`
	MaxMsgSize   int      `toml:"max_msg_size"`
	// contains filtered or unexported fields
}

CiscoTelemetryMDT plugin for IOS XR, IOS XE and NXOS platforms

func (*CiscoTelemetryMDT) Address

func (c *CiscoTelemetryMDT) Address() net.Addr

func (*CiscoTelemetryMDT) Description

func (c *CiscoTelemetryMDT) Description() string

Description of plugin

func (*CiscoTelemetryMDT) Gather

func (c *CiscoTelemetryMDT) Gather(_ context.Context, _ cua.Accumulator) error

Gather plugin measurements (unused)

func (*CiscoTelemetryMDT) MdtDialout

func (c *CiscoTelemetryMDT) MdtDialout(stream dialout.GRPCMdtDialout_MdtDialoutServer) error

MdtDialout RPC server method for grpc-dialout transport

func (*CiscoTelemetryMDT) SampleConfig

func (c *CiscoTelemetryMDT) SampleConfig() string

SampleConfig of plugin

func (*CiscoTelemetryMDT) Start

func (c *CiscoTelemetryMDT) Start(ctx context.Context, acc cua.Accumulator) error

Start the Cisco MDT service

func (*CiscoTelemetryMDT) Stop

func (c *CiscoTelemetryMDT) Stop()

Stop listener and cleanup