types

Documentation

Index

• type AddressType
• type ExtendedHistogram
  • func NewHistogram(unit histogram.Unit, slots []uint32, addressType AddressType, addr string, ...) *ExtendedHistogram
• type Report

Types

type AddressType

type AddressType string

const (
	AddressTypeLocal  AddressType = "Local"
	AddressTypeRemote AddressType = "Remote"
	AddressTypeAll    AddressType = "All Addresses"

	WildcardAddress = "******"
)

type ExtendedHistogram

type ExtendedHistogram struct {
	// Histogram is the Histogram of the RTT values.
	*histogram.Histogram `json:",inline"`

	// Address is the address for which the histogram was created. It is
	// AllAddresses for a global histogram.
	Address string `json:"address,omitempty"`

	// AddressType is the type of the address for which the histogram was
	// created. It is AddressTypeAll for a global histogram.
	AddressType AddressType `json:"addressType,omitempty"`

	// Average is the average value of the histogram.
	Average float64 `json:"average,omitempty"`

	// LocalPort is the local port used to filter address.
	// If it is 0, it means there was not filtering on local port.
	LocalPort uint16 `json:"localPort,omitempty"`

	// RemotePort is the local port used to filter address.
	// If it is 0, it means there was not filtering on remote port.
	RemotePort uint16 `json:"remotePort,omitempty"`
}

ExtendedHistogram extends the histogram.Histogram type with the address and address type for which the histogram was created. In addition, it adds the average value of the histogram.

func NewHistogram

func NewHistogram(
	unit histogram.Unit,
	slots []uint32,
	addressType AddressType,
	addr string,
	avg float64,
	localPort uint16,
	remotePort uint16,
) *ExtendedHistogram

type Report

type Report struct {
	Histograms []*ExtendedHistogram `json:"histograms,omitempty"`
}