flow

Documentation

Index

• Constants
• type BaseFilter
• type Condition
  • func (con Condition) String() string
• type CountryR
• type Filter
  • func AddRule[T RuleVal](f *Filter, key string, op Operator, value T) *Filter
  • func AddSubFilterRule(f *Filter, value *SubFilter) *Filter
  • func NewFilter(c Condition) *Filter
• type Operator
  • func (op Operator) String() string
• type PercentileData
  • func (p *PercentileData) UnmarshalJSON(b []byte) error
• type QueryParameters
  • func (q *QueryParameters) MarshalQuery() (map[string]string, error)
• type QueryResults
• type ResPercentileQuery
• type RuleInterface
• type RuleP
• type RuleVal
• type SubFilter
  • func AddSubRule[T RuleVal](sf *SubFilter, key string, op Operator, value T) *SubFilter
  • func NewSubFilter(c Condition) *SubFilter

Constants

const AS string = "as"

const ASEgress string = "as-egress"

const ASIngress string = "as-ingress"

const Addr string = "addr"

const ApplicationName string = "application-name"

const Ascending string = "ascending"

const Avg string = "avg"

const BGPLocalPref string = "bgp-localpref"

const BGPMed string = "bgp-med"

const BidirectionalLeft string = "bidirectional-left"

const BidirectionalRight string = "bidirectional-right"

const City string = "city"

const Community string = "community"

const Count string = "count"

const Country string = "country"

const Descending string = "descending"

const Device string = "device"

const DstAS string = "dst-as"

const DstASPath string = "dst-as-path"

const DstAddr string = "dst-addr"

const DstCity string = "dst-city"

const DstCountry string = "dst-country"

const DstMask string = "dst-mask"

const DstPort string = "dst-port"

const ExporterAS string = "exporter-as"

const ExporterID string = "exporter-id"

const ExporterIP string = "exporter-ip"

const FlowRole string = "flow-role"

const Flows string = "flows"

const IPVersion string = "ip-version"

const InputInterface string = "input-interface"

const Interface string = "interface"

const L2EthernetType string = "l2-ethernet-type"

const L2MACAddr string = "l2-mac-addr"

const L2MACDstAddr string = "l2-mac-dst-addr"

const L2MACSrcAddr string = "l2-mac-src-addr"

const L3IPMaxTTL string = "l3-ip-max-ttl"

const L3IPMaxTotalLength string = "l3-ip-max-total-length"

const L3IPMinTTL string = "l3-ip-min-ttl"

const L3IPMinTotalLength string = "l3-ip-min-total-length"

const L3IPTTL string = "l3-ip-ttl"

const L3IPTotalLength string = "l3-ip-total-length"

const L4TCPFlag string = "l4-tcp-flag"

const L4TCPFlagCount string = "l4-tcp-flag-count"

const Location string = "location"

const MPLSLabelStackDepth string = "mpls-label-stack-depth"

const MPLSLabelStackLength string = "mpls-label-stack-length"

const MPLSPostTopLabelExp string = "mpls-post-top-label-exp"

const MPLSTopLabelExp string = "mpls-top-label-exp"

const MPLSTopLabelIPv4 string = "mpls-top-label-ipv4"

const MPLSTopLabelIPv6 string = "mpls-top-label-ipv6"

const MPLSTopLabelPrefixLength string = "mpls-top-label-prefix-length"

const MPLSTopLabelStackSection string = "mpls-top-label-stack-section"

const MPLSTopLabelStackSection1 string = "mpls-top-label-stack-section1"

const MPLSTopLabelStackSection2 string = "mpls-top-label-stack-section2"

const MPLSTopLabelStackSection3 string = "mpls-top-label-stack-section3"

const MPLSTopLabelStackSection4 string = "mpls-top-label-stack-section4"

const MPLSTopLabelStackSection5 string = "mpls-top-label-stack-section5"

const MPLSTopLabelStackSection6 string = "mpls-top-label-stack-section6"

const MPLSTopLabelStackSection7 string = "mpls-top-label-stack-section7"

const MPLSTopLabelStackSection8 string = "mpls-top-label-stack-section8"

const MPLSTopLabelStackSection9 string = "mpls-top-label-stack-section9"

const MPLSTopLabelTTL string = "mpls-top-label-ttl"

const MPLSTopLabelType string = "mpls-top-label-type"

const MPLSVpnRouteDistinguisher string = "mpls-vpn-route-distinguisher"

const Max string = "max"

const Min string = "min"

const NextHop string = "next-hop"

const Octets string = "octets"

const OutputInterface string = "output-interface"

const Packets string = "packets"

const Port string = "port"

const Protocol string = "protocol"

const PseudoWireControlWord string = "pseudo-wire-control-word"

const PseudoWireID string = "pseudo-wire-id"

const PseudoWireType string = "pseudo-wire-type"

const Seconds string = "seconds"

const SrcAS string = "src-as"

const SrcASPath string = "src-as-path"

const SrcAddr string = "src-addr"

const SrcCity string = "src-city"

const SrcCountry string = "src-country"

const SrcMask string = "src-mask"

const SrcPort string = "src-port"

const Sum string = "sum"

const TOS string = "tos"

const TS string = "ts"

const Uniq string = "uniq"

Types

type BaseFilter

type BaseFilter struct {
	Condition Condition `json:"condition"`
	Rules     []RuleP   `json:"rules"`
}

type Condition

type Condition string

const AND Condition = "and"

const OR Condition = "or"

func (Condition) String

func (con Condition) String() string

type CountryR

type CountryR struct {
	Code string `json:"code"`
	Name string `json:"name"`
}

type Filter

type Filter struct {
	Condition Condition        `json:"condition"`
	Rules     []map[string]any `json:"rules"`
}

func AddRule

func AddRule[T RuleVal](f *Filter, key string, op Operator, value T) *Filter

func AddSubFilterRule

func AddSubFilterRule(f *Filter, value *SubFilter) *Filter

func NewFilter

func NewFilter(c Condition) *Filter

type Operator

type Operator string

const EQ Operator = "eq"

const GE Operator = "ge"

const GT Operator = "gt"

const LE Operator = "le"

const LT Operator = "lt"

const NEQ Operator = "noteq"

func (Operator) String

func (op Operator) String() string

type PercentileData

type PercentileData struct {
	Timestamp time.Time
	Data      float64
}

func (*PercentileData) UnmarshalJSON

func (p *PercentileData) UnmarshalJSON(b []byte) error

type QueryParameters

type QueryParameters struct {
	// required
	StartTime time.Time `json:"start-time"`

	// required
	EndTime time.Time `json:"end-time"`

	Filters *Filter `json:"filters"`

	// ts, ip-version, src-addr, dst-addr, tos, protocol, src-port, dst-port, input-interface,
	// output-interface, src-mask, dst-mask, src-as, dst-as, next-hop, src-as-path, dst-as-path,
	// src-country, dst-country, src-city, dst-city, exporter-ip, exporter-id, exporter-as,
	// bgp-localpref, bgp-med, l2-mac-src-addr, l2-mac-dst-addr, l2-ethernet-type,
	// mpls-top-label-stack-section, mpls-top-label-stack-section1, mpls-top-label-stack-section2,
	// mpls-top-label-stack-section3, mpls-top-label-stack-section4, mpls-top-label-stack-section5,
	// mpls-top-label-stack-section6, mpls-top-label-stack-section7, mpls-top-label-stack-section8,
	// mpls-top-label-stack-section9, mpls-top-label-type, mpls-top-label-ipv4,
	// mpls-vpn-route-distinguisher, mpls-top-label-prefix-length, mpls-top-label-ipv6,
	// mpls-top-label-ttl, mpls-label-stack-length, mpls-label-stack-depth, mpls-top-label-exp,
	// mpls-post-top-label-exp, pseudo-wire-id, pseudo-wire-type, pseudo-wire-control-word,
	// community, l3-ip-min-total-length, l3-ip-max-total-length, l3-ip-total-length,
	// l3-ip-min-ttl, l3-ip-max-ttl, l3-ip-ttl, l4-tcp-flag, flow-role, application-name
	GroupBy string `json:"groupby,omitempty"`

	// ts, ip-version, src-addr, dst-addr, tos, protocol, src-port, dst-port,
	// input-interface, output-interface, src-mask, dst-mask, src-as, dst-as,
	// next-hop, octets, packets, flows, src-vlan, dst-vlan, dst-as-path, src-as-path,
	// src-country, dst-country, src-city, dst-city, bgp-localpref, bgp-med, exporter-ip,
	// exporter-id, exporter-as, l2-mac-src-addr, l2-mac-dst-addr, l2-ethernet-type,
	// mpls-top-label-stack-section, mpls-top-label-stack-section1, mpls-top-label-stack-section2,
	// mpls-top-label-stack-section3, mpls-top-label-stack-section4, mpls-top-label-stack-section5,
	// mpls-top-label-stack-section6, mpls-top-label-stack-section7, mpls-top-label-stack-section8,
	// mpls-top-label-stack-section9, mpls-top-label-type, mpls-top-label-ipv4,
	// mpls-vpn-route-distinguisher, mpls-top-label-prefix-length, mpls-top-label-ipv6,
	// mpls-top-label-ttl, mpls-label-stack-length, mpls-label-stack-depth, mpls-top-label-exp,
	// mpls-post-top-label-exp, pseudo-wire-id, pseudo-wire-type, pseudo-wire-control-word,
	// community, l3-ip-min-total-length, l3-ip-max-total-length, l3-ip-total-length, l3-ip-min-ttl,
	// l3-ip-max-ttl, l3-ip-ttl, l4-tcp-syn-count, l4-tcp-fin-count, l4-tcp-rst-count,
	// l4-tcp-psh-count, l4-tcp-ack-count, l4-tcp-urg-count, flow-role, application-name
	TableColumns []string `json:"table-columns,omitempty"`

	// octets, packets, flows, l4-tcp-flag-count
	AggregateBy string `json:"aggregate-by,omitempty"`

	// count, min, max, avg, uniq, sum
	AggregateFunction string `json:"aggregate-function,omitempty"`

	// ts, ip-version, src-addr, dst-addr, tos, protocol, src-port, dst-port, input-interface,
	// output-interface, src-mask, dst-mask, src-as, dst-as, next-hop, src-as-path, dst-as-path,
	// octets, packets, exporter-ip, exporter-id, exporter-as, flows, bgp-localpref, bgp-med,
	// l2-mac-src-addr, l2-mac-dst-addr, l2-ethernet-type, mpls-top-label-stack-section,
	// mpls-top-label-stack-section1, mpls-top-label-stack-section2, mpls-top-label-stack-section3,
	// mpls-top-label-stack-section4, mpls-top-label-stack-section5, mpls-top-label-stack-section6,
	// mpls-top-label-stack-section7, mpls-top-label-stack-section8, mpls-top-label-stack-section9,
	// mpls-top-label-type, mpls-top-label-ipv4, mpls-vpn-route-distinguisher,
	// mpls-top-label-prefix-length, mpls-top-label-ipv6, mpls-top-label-ttl,
	// mpls-label-stack-length, mpls-label-stack-depth, mpls-top-label-exp,
	// mpls-post-top-label-exp, pseudo-wire-id, pseudo-wire-type, pseudo-wire-control-word,
	// community, l3-ip-min-total-length, l3-ip-max-total-length, l3-ip-total-length,
	// l3-ip-min-ttl, l3-ip-max-ttl, l3-ip-ttl, l4-tcp-flag-count, flow-role, application-name
	OrderBy string `json:"orderby,omitempty"`

	// descending, ascending
	Order string `json:"order,omitempty"`

	Top      uint32 `json:"top,omitempty"`
	Page     uint32 `json:"page,omitempty"`
	PageSize uint16 `json:"page-size,omitempty"`

	// location, device, interface
	FiltersNarrowBy []string `json:"filters-narrow-by,omitempty"`

	// seconds
	RateUnit string `json:"rate-unit,omitempty"`

	IsolateEmptySpaces  bool  `json:"isolate-empty-spaces,omitempty"`
	GroupBySrcPrefix    bool  `json:"group-by-src-prefix,omitempty"`
	GroupBySrcPrefixLen bool  `json:"group-by-src-prefix-length,omitempty"`
	GroupByDstPrefix    bool  `json:"group-by-dst-prefix,omitempty"`
	GroupByDstPrefixLen bool  `json:"group-by-dst-prefix-length,omitempty"`
	ASPathPrependRemove bool  `json:"as-path-prepend-remove,omitempty"`
	Percentile          uint8 `json:"percentile,omitempty"`
	Dictionary          bool  `json:"dictionary,omitempty"`
	TableMinMax         bool  `json:"table-min-max,omitempty"`

	// addr, port, as, country, city, l2-mac-addr
	GroupByBidirectional string `json:"groupby-bidirectional,omitempty"`

	GroupByTSBidirectional bool `json:"groupby-ts-bidirectional,omitempty"`

	// ts, octets, flows, packets, l4-tcp-flag-count, bidirectional-left, bidirectional-right
	OrderByBidirectional string `json:"orderby-bidirectional,omitempty"`

	// as-ingress, as-egress
	TrafficDirection string `json:"traffic-direction,omitempty"`

	// minimum 60
	Step uint32 `json:"step,omitempty"`
}

func (*QueryParameters) MarshalQuery

func (q *QueryParameters) MarshalQuery() (map[string]string, error)

type QueryResults

type QueryResults struct {
	Code string `json:"code"`
}

type ResPercentileQuery

type ResPercentileQuery struct {
	Results         []QueryResults   `json:"results"`
	PercentileValue float64          `json:"percentileValue"`
	QueryParams     map[string]any   `json:"queryParams"`
	Title           string           `json:"title"`
	Header          []string         `json:"header"`
	Step            int              `json:"step"`
	Data            []PercentileData `json:"data"`
}

type RuleInterface

type RuleInterface interface {
	Key() string
	Value() any
	Operator() Operator
}

type RuleP

type RuleP struct {
	Key      string   `json:"key"`
	Operator Operator `json:"comparisonOperator"`
	Value    any      `json:"value"`
}

type RuleVal

type RuleVal interface {
	string | int | uint8 | uint16 | uint32 | uint64 | []string | []uint32 | CountryR
}

type SubFilter

type SubFilter struct {
	Condition Condition        `json:"condition"`
	Rules     []map[string]any `json:"rules"`
}

func AddSubRule

func AddSubRule[T RuleVal](sf *SubFilter, key string, op Operator, value T) *SubFilter

func NewSubFilter

func NewSubFilter(c Condition) *SubFilter