aos

README

AOS Listener

Disclaimer

WARNING: This plugin is experimental and should not be used in production.

Support

This plugin supports AOS up to version 3.1.0.

Overview

Input Plugins for Apstra AOS Telemetry Streaming

• Configure Streaming Session on AOS Server
• Listen on TCP Port and decode AOS GPB
• Construct Time Series Information
• Collect Additional info from AOS over REST API

Configuration

[[inputs.aos]]
  # TCP Port to listen for incoming sessions from the AOS Server
  port = 7777                   # mandatory

  # Address of the server running Telegraf, it needs to be reacheable from AOS
  address = 192.168.59.1        # mandatory

  # Interval to refresh content from the AOS server (in sec)
  refresh_interval = 30         # Default 30

  # Streaming Type Can be "perfmon", "alerts" or "events"
  streaming_type = [ "events" ]

  # Define parameter to join the AOS Server using the REST API
  aos_server = 192.168.59.250   # mandatory
  aos_port = 8888               # Default 8888
  aos_login = admin             # Default admin
  aos_password = admin          # Default admin

Documentation

Index

• type Aos
  • func (aos *Aos) Description() string
  • func (aos *Aos) Gather(_ telegraf.Accumulator) error
  • func (aos *Aos) RefreshData()
  • func (aos *Aos) SampleConfig() string
  • func (aos *Aos) Start(acc telegraf.Accumulator) error
  • func (aos *Aos) Stop()
• type StreamAos
  • func (ssl *StreamAos) ExtractAlertData(alertType string, tags map[string]string, alertData interface{}, raised bool)
  • func (ssl *StreamAos) ExtractProbeData(newProbeMessage interface{}, originName string)
  • func (ssl *StreamAos) GetTags(deviceKey string) map[string]string
  • func (ssl *StreamAos) MsgReader(r io.Reader)

Types

type Aos

type Aos struct {
	Port          int
	Address       string
	StreamingType []string

	AosServer   string
	AosPort     int
	AosLogin    string
	AosPassword string
	AosProtocol string

	RefreshInterval int

	telegraf.Accumulator
	io.Closer
	// contains filtered or unexported fields
}

---------------------------------------------------------------- Aos "Class" ----------------------------------------------------------------

func (*Aos) Description

func (aos *Aos) Description() string

func (*Aos) Gather

func (aos *Aos) Gather(_ telegraf.Accumulator) error

func (*Aos) RefreshData

func (aos *Aos) RefreshData()

Continuous Query that will refresh data every 15 sec

func (*Aos) SampleConfig

func (aos *Aos) SampleConfig() string

func (*Aos) Start

func (aos *Aos) Start(acc telegraf.Accumulator) error

func (*Aos) Stop

func (aos *Aos) Stop()

type StreamAos

type StreamAos struct {
	net.Listener
	*Aos
}

---------------------------------------------------------------- StreamAos "Class" ----------------------------------------------------------------

func (*StreamAos) ExtractAlertData

func (ssl *StreamAos) ExtractAlertData(alertType string, tags map[string]string, alertData interface{}, raised bool)

func (*StreamAos) ExtractProbeData

func (ssl *StreamAos) ExtractProbeData(newProbeMessage interface{}, originName string)

func (*StreamAos) GetTags

func (ssl *StreamAos) GetTags(deviceKey string) map[string]string

func (*StreamAos) MsgReader

func (ssl *StreamAos) MsgReader(r io.Reader)