nfa

README

go-nfa

[In Progress] Go client for Noction Netflow Analyzer

Testing Environment Variables

The following environment variables must be set (and valid) for tests to run.

Key	Description
NFA_URL	URL to NFA instance
NFA_USERNAME	NFA Username
NFA_PASSWORD	NFA Password

Documentation

Index

• Variables
• func CreatePrefixRange(prefix string) (string, error)
• func NewPercentileQuery(prefixes []string, exclusions []string, p uint8) (*flow.QueryParameters, error)
• func ParseURL(u string) (*url.URL, error)
• type AuthResponse
• type Client
  • func New(options ...OptionSetter) (*Client, error)
  • func (client *Client) PercentileQuery(prefixes, exclude []string, percentile uint8) (*flow.ResPercentileQuery, error)
• type OptionSetter
  • func Insecure() OptionSetter
  • func Password(p string) OptionSetter
  • func Precision(p uint) OptionSetter
  • func RetryCount(c int) OptionSetter
  • func RetryTime(d time.Duration) OptionSetter
  • func URL(u *url.URL) OptionSetter
  • func Username(u string) OptionSetter
• type Options
  • func (opts *Options) Validate() error
• type ProcessingResponse

Variables

var ErrCfgNoPassword = errors.New("username required")

var ErrCfgNoURL = errors.New("URL required")

var ErrCfgNoUsername = errors.New("username required")

Functions

func CreatePrefixRange

func CreatePrefixRange(prefix string) (string, error)

func NewPercentileQuery

func NewPercentileQuery(prefixes []string, exclusions []string, p uint8) (*flow.QueryParameters, error)

func ParseURL

func ParseURL(u string) (*url.URL, error)

ParseURL parses an NFA URL from a string to a *url.URL, sets the appropriate URI schema, and sets the correct path.

Types

type AuthResponse

type AuthResponse struct {
	Result struct {
		Code    string `json:"code"`
		Message string `json:"message,omitempty"`
	} `json:"result"`
}

type Client

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

func New

func New(options ...OptionSetter) (*Client, error)

func (*Client) PercentileQuery

func (client *Client) PercentileQuery(prefixes, exclude []string, percentile uint8) (*flow.ResPercentileQuery, error)

type OptionSetter

type OptionSetter func(*Options)

func Insecure

func Insecure() OptionSetter

Insecure disables SSL certificate validation when communicating with NFA.

func Password

func Password(p string) OptionSetter

Password sets the authentication password. This option is required.

func Precision

func Precision(p uint) OptionSetter

Decimals sets the precision to round percentile values. 100 = 2 decimal places.

func RetryCount

func RetryCount(c int) OptionSetter

RetryCount sets the number of times to retry requests.

func RetryTime

func RetryTime(d time.Duration) OptionSetter

RetryTime sets the amount of time to wait between retries.

func URL

func URL(u *url.URL) OptionSetter

URL sets the NFA base URL. This option is required. See ParseURL helper.

func Username

func Username(u string) OptionSetter

Username sets the authentication username. This option is required.

type Options

type Options struct {
	Insecure   bool
	URL        *url.URL
	Username   string
	Password   string
	RetryCount int
	RetryTime  time.Duration
	Precision  uint
}

func (*Options) Validate

func (opts *Options) Validate() error

type ProcessingResponse

type ProcessingResponse struct {
	Code        string `json:"code"`
	Description string `json:"description"`
}