server

Documentation

Overview

Package server implements a component that runs the netflow server. When running, it listens for network traffic according to configured listeners and aggregates traffic data to send to the backend. It does not expose any public methods.

Index

• func Module() fxutil.Module
• type Component
• type Provider
  • func (p Provider) HTML(_ bool, buffer io.Writer) error
  • func (p Provider) JSON(_ bool, stats map[string]interface{}) error
  • func (Provider) Name() string
  • func (Provider) Section() string
  • func (p Provider) Text(_ bool, buffer io.Writer) error
• type Server
  • func (s *Server) Start() error
  • func (s *Server) Stop()

Functions

func Module

func Module() fxutil.Module

Module defines the fx options for this component.

Types

type Component

type Component interface{}

Component is the component type. It has no exposed methods.

type Provider

type Provider struct {
	// contains filtered or unexported fields
}

Provider provides the functionality to populate the status output

func (Provider) HTML

func (p Provider) HTML(_ bool, buffer io.Writer) error

HTML renders the html output

func (Provider) JSON

func (p Provider) JSON(_ bool, stats map[string]interface{}) error

JSON populates the status map

func (Provider) Name

func (Provider) Name() string

Name returns the name

func (Provider) Section

func (Provider) Section() string

Section return the section

func (Provider) Text

func (p Provider) Text(_ bool, buffer io.Writer) error

Text renders the text output

type Server

type Server struct {
	Addr string

	FlowAgg *flowaggregator.FlowAggregator
	// contains filtered or unexported fields
}

Server manages netflow listeners.

func (*Server) Start

func (s *Server) Start() error

Start starts the server running

func (*Server) Stop

func (s *Server) Stop()

Stop stops the Server.