report

package
v0.10.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 16, 2015 License: Apache-2.0 Imports: 15 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	// ScopeDelim is a general-purpose delimiter used within node IDs to
	// separate different contextual scopes. Different topologies have
	// different key structures.
	ScopeDelim = ";"

	// EdgeDelim separates two node IDs when they need to exist in the same key.
	// Concretely, it separates node IDs in keys that represent edges.
	EdgeDelim = "|"
)

Delimiters are used to separate parts of node IDs, to guarantee uniqueness in particular contexts.

View Source 
const (
	// HostNodeID is a metadata foreign key, linking a node in any topology to
	// a node in the host topology. That host node is the origin host, where
	// the node was originally detected.
	HostNodeID = "host_node_id"
	// ProbeID is the random ID of the probe which generated the specific node.
	ProbeID = "probe_id"
)
View Source 
const TheInternet = "theinternet"

TheInternet is used as a node ID to indicate a remote IP.

Variables

View Source 
var (
	LocalNetworks       = Networks{}
	InterfaceByNameStub = func(name string) (Interface, error) { return net.InterfaceByName(name) }
)

Variables exposed for testing. TODO this design is broken, make it consistent with probe networks.

Functions

func AddLocalBridge added in v0.4.0 

func AddLocalBridge(name string) error

AddLocalBridge records the subnet address associated with the bridge name supplied, such that MakeAddressNodeID will scope addresses in this subnet as local.

func ExtractHostID added in v0.4.0 

func ExtractHostID(m Node) string

ExtractHostID extracts the host id from Node

func LocalAddresses added in v0.9.0 

func LocalAddresses() ([]net.IP, error)

LocalAddresses returns a list of the local IP addresses.

func MakeAddressNodeID added in v0.3.0 

func MakeAddressNodeID(hostID, address string) string

MakeAddressNodeID produces an address node ID from its composite parts.

func MakeContainerNodeID added in v0.3.0 

func MakeContainerNodeID(hostID, containerID string) string

MakeContainerNodeID produces a container node ID from its composite parts.

func MakeEndpointNodeID added in v0.3.0 

func MakeEndpointNodeID(hostID, address, port string) string

MakeEndpointNodeID produces an endpoint node ID from its composite parts.

func MakeHostNodeID added in v0.3.0 

func MakeHostNodeID(hostID string) string

MakeHostNodeID produces a host node ID from its composite parts.

func MakeOverlayNodeID added in v0.4.0 

func MakeOverlayNodeID(peerName string) string

MakeOverlayNodeID produces an overlay topology node ID from a router peer's name, which is assumed to be globally unique.

func MakePodNodeID added in v0.9.0 

func MakePodNodeID(hostID, podID string) string

MakePodNodeID produces a pod node ID from its composite parts.

func MakeProcessNodeID added in v0.3.0 

func MakeProcessNodeID(hostID, pid string) string

MakeProcessNodeID produces a process node ID from its composite parts.

func MakeScopedAddressNodeID added in v0.9.0 

func MakeScopedAddressNodeID(hostID, address string) string

MakeScopedAddressNodeID is like MakeAddressNodeID, but it always prefixes the ID witha scope.

func MakeScopedEndpointNodeID added in v0.9.0 

func MakeScopedEndpointNodeID(hostID, address, port string) string

MakeScopedEndpointNodeID is like MakeEndpointNodeID, but it always prefixes the ID witha scope.

func MakeServiceNodeID added in v0.9.0 

func MakeServiceNodeID(namespaceID, serviceID string) string

MakeServiceNodeID produces a service node ID from its composite parts.

func ParseAddressNodeID added in v0.7.0 

func ParseAddressNodeID(addressNodeID string) (hostID, address string, ok bool)

ParseAddressNodeID produces the host ID, address from an address node ID.

func ParseContainerNodeID added in v0.7.0 

func ParseContainerNodeID(containerNodeID string) (hostID, containerID string, ok bool)

ParseContainerNodeID produces the host and container id from an container node ID.

func ParseEndpointNodeID added in v0.5.0 

func ParseEndpointNodeID(endpointNodeID string) (hostID, address, port string, ok bool)

ParseEndpointNodeID produces the host ID, address, and port and remainder (typically an address) from an endpoint node ID. Note that hostID may be blank.

func ParseNodeID added in v0.3.0 

func ParseNodeID(nodeID string) (hostID string, remainder string, ok bool)

ParseNodeID produces the host ID and remainder (typically an address) from a node ID. Note that hostID may be blank.

Types

type Control added in v0.10.0 

type Control struct {
	ID    string `json:"id"`
	Human string `json:"human"`
	Icon  string `json:"icon"` // from https://fortawesome.github.io/Font-Awesome/cheatsheet/ please
}

A Control basically describes an RPC

type Controls added in v0.10.0 

type Controls map[string]Control

Controls describe the control tags within the Nodes

func (Controls) AddControl added in v0.10.0 

func (cs Controls) AddControl(c Control)

AddControl returns a fresh Controls, c added to cs.

func (Controls) Copy added in v0.10.0 

func (cs Controls) Copy() Controls

Copy produces a copy of cs.

func (Controls) Merge added in v0.10.0 

func (cs Controls) Merge(other Controls) Controls

Merge merges other with cs, returning a fresh Controls.

type Counters added in v0.7.0 

type Counters map[string]int

Counters is a string->int map.

func (Counters) Copy added in v0.7.0 

func (c Counters) Copy() Counters

Copy creates a deep copy of the Counters.

func (Counters) Merge added in v0.7.0 

func (c Counters) Merge(other Counters) Counters

Merge merges two sets of counters into a fresh set of counters, summing values where appropriate.

type EdgeMetadata 

type EdgeMetadata struct {
	EgressPacketCount  *uint64 `json:"egress_packet_count,omitempty"`
	IngressPacketCount *uint64 `json:"ingress_packet_count,omitempty"`
	EgressByteCount    *uint64 `json:"egress_byte_count,omitempty"`  // Transport layer
	IngressByteCount   *uint64 `json:"ingress_byte_count,omitempty"` // Transport layer
	MaxConnCountTCP    *uint64 `json:"max_conn_count_tcp,omitempty"`
}

EdgeMetadata describes a superset of the metadata that probes can possibly collect about a directed edge between two nodes in any topology.

func (EdgeMetadata) Copy added in v0.7.0 

func (e EdgeMetadata) Copy() EdgeMetadata

Copy returns a value copy of the EdgeMetadata.

func (EdgeMetadata) Flatten 

func (e EdgeMetadata) Flatten(other EdgeMetadata) EdgeMetadata

Flatten sums two EdgeMetadatas and returns the result. The receiver is not modified. The two edge metadata windows should be the same duration; they should represent different edges at the same time.

func (EdgeMetadata) Merge 

func (e EdgeMetadata) Merge(other EdgeMetadata) EdgeMetadata

Merge merges another EdgeMetadata into the receiver and returns the result. The receiver is not modified. The two edge metadatas should represent the same edge on different times.

func (EdgeMetadata) Reversed added in v0.8.0 

func (e EdgeMetadata) Reversed() EdgeMetadata

Reversed returns a value copy of the EdgeMetadata, with the direction reversed.

type EdgeMetadatas 

type EdgeMetadatas map[string]EdgeMetadata

EdgeMetadatas collect metadata about each edge in a topology. Keys are the remote node IDs, as in Adjacency.

func (EdgeMetadatas) Copy added in v0.7.0 

func (e EdgeMetadatas) Copy() EdgeMetadatas

Copy returns a value copy of the EdgeMetadatas.

func (EdgeMetadatas) Flatten added in v0.7.0 

func (e EdgeMetadatas) Flatten() EdgeMetadata

Flatten flattens all the EdgeMetadatas in this set and returns the result. The original is not modified.

func (EdgeMetadatas) Merge 

func (e EdgeMetadatas) Merge(other EdgeMetadatas) EdgeMetadatas

Merge merges the other object into this one, and returns the result object. The original is not modified.

type IDList 

type IDList StringSet

IDList is a list of string IDs, which are always sorted and unique.

func MakeIDList added in v0.3.0 

func MakeIDList(ids ...string) IDList

MakeIDList makes a new IDList.

func (IDList) Add 

func (a IDList) Add(ids ...string) IDList

Add is the only correct way to add ids to an IDList.

func (IDList) Contains added in v0.3.0 

func (a IDList) Contains(id string) bool

Contains returns true if id is in the list.

func (IDList) Copy added in v0.7.0 

func (a IDList) Copy() IDList

Copy returns a copy of the IDList.

func (IDList) Merge added in v0.5.0 

func (a IDList) Merge(b IDList) IDList

Merge all elements from a and b into a new list

type Interface added in v0.4.0 

type Interface interface {
	Addrs() ([]net.Addr, error)
}

Interface is exported for testing.

type LatestEntry added in v0.10.0 

type LatestEntry struct {
	Timestamp time.Time `json:"timestamp"`
	Value     string    `json:"value"`
}

LatestEntry represents a timestamped value inside the LatestMap.

func (LatestEntry) String added in v0.10.0 

func (e LatestEntry) String() string

type LatestMap added in v0.10.0 

type LatestMap struct {
	ps.Map
}

LatestMap is a persitent map which support latest-win merges. We have to embed ps.Map as its an interface. LatestMaps are immutable.

func MakeLatestMap added in v0.10.0 

func MakeLatestMap() LatestMap

MakeLatestMap makes an empty LatestMap

func (LatestMap) Copy added in v0.10.0 

func (m LatestMap) Copy() LatestMap

Copy is a noop, as LatestMaps are immutable.

func (*LatestMap) GobDecode added in v0.10.0 

func (m *LatestMap) GobDecode(input []byte) error

GobDecode implements gob.Unmarshaller

func (LatestMap) GobEncode added in v0.10.0 

func (m LatestMap) GobEncode() ([]byte, error)

GobEncode implements gob.Marshaller

func (LatestMap) Lookup added in v0.10.0 

func (m LatestMap) Lookup(key string) (string, bool)

Lookup the value for the given key.

func (LatestMap) MarshalJSON added in v0.10.0 

func (m LatestMap) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaller

func (LatestMap) Merge added in v0.10.0 

func (m LatestMap) Merge(newer LatestMap) LatestMap

Merge produces a fresh LatestMap, container the kers from both inputs. When both inputs container the same key, the latter value is used.

func (LatestMap) Set added in v0.10.0 

func (m LatestMap) Set(key string, timestamp time.Time, value string) LatestMap

Set the value for the given key.

func (*LatestMap) UnmarshalJSON added in v0.10.0 

func (m *LatestMap) UnmarshalJSON(input []byte) error

UnmarshalJSON implements json.Unmarshaler

type Metadata added in v0.7.0 

type Metadata map[string]string

Metadata is a string->string map.

func (Metadata) Copy added in v0.7.0 

func (m Metadata) Copy() Metadata

Copy creates a deep copy of the Metadata.

func (Metadata) Merge added in v0.7.0 

func (m Metadata) Merge(other Metadata) Metadata

Merge merges two node metadata maps together. In case of conflict, the other (right-hand) side wins. Always reassign the result of merge to the destination. Merge does not modify the receiver.

type Metric added in v0.10.0 

type Metric struct {
	Samples     ps.List
	Min, Max    float64
	First, Last time.Time
}

Metric is a list of timeseries data with some metadata. Clients must use the Add method to add values. Metrics are immutable.

func MakeMetric added in v0.10.0 

func MakeMetric() Metric

MakeMetric makes a new Metric.

func (Metric) Add added in v0.10.0 

func (m Metric) Add(t time.Time, v float64) Metric

Add returns a new Metric with (t, v) added to its Samples. Add is the only valid way to grow a Metric.

func (Metric) Copy added in v0.10.0 

func (m Metric) Copy() Metric

Copy returns a value copy of the Metric. Metric is immutable, so we can skip this.

func (Metric) Div added in v0.10.0 

func (m Metric) Div(n float64) Metric

Div returns a new copy of the metric, with each value divided by n.

func (*Metric) GobDecode added in v0.10.0 

func (m *Metric) GobDecode(input []byte) error

GobDecode implements gob.Unmarshaller

func (Metric) GobEncode added in v0.10.0 

func (m Metric) GobEncode() ([]byte, error)

GobEncode implements gob.Marshaller

func (Metric) LastSample added in v0.10.0 

func (m Metric) LastSample() *Sample

LastSample returns the last sample in the metric, or nil if there are no samples.

func (Metric) Len added in v0.10.0 

func (m Metric) Len() int

Len returns the number of samples in the metric.

func (Metric) MarshalJSON added in v0.10.0 

func (m Metric) MarshalJSON() ([]byte, error)

MarshalJSON implements json.Marshaller

func (Metric) Merge added in v0.10.0 

func (m Metric) Merge(other Metric) Metric

Merge combines the two Metrics and returns a new result.

func (*Metric) UnmarshalJSON added in v0.10.0 

func (m *Metric) UnmarshalJSON(input []byte) error

UnmarshalJSON implements json.Unmarshaler

func (Metric) WithFirst added in v0.10.0 

func (m Metric) WithFirst(t time.Time) Metric

WithFirst returns a fresh copy of m, with First set to t.

type Metrics added in v0.10.0 

type Metrics map[string]Metric

Metrics is a string->metric map.

func (Metrics) Copy added in v0.10.0 

func (m Metrics) Copy() Metrics

Copy returns a value copy of the sets map.

func (Metrics) Merge added in v0.10.0 

func (m Metrics) Merge(other Metrics) Metrics

Merge merges two sets maps into a fresh set, performing set-union merges as appropriate.

type Networks added in v0.4.0 

type Networks []*net.IPNet

Networks represent a set of subnets

func (Networks) Contains added in v0.4.0 

func (n Networks) Contains(ip net.IP) bool

Contains returns true if IP is in Networks.

type Node added in v0.7.0 

type Node struct {
	Metadata  Metadata      `json:"metadata,omitempty"`
	Counters  Counters      `json:"counters,omitempty"`
	Sets      Sets          `json:"sets,omitempty"`
	Adjacency IDList        `json:"adjacency"`
	Edges     EdgeMetadatas `json:"edges,omitempty"`
	Controls  NodeControls  `json:"controls,omitempty"`
	Latest    LatestMap     `json:"latest,omitempty"`
	Metrics   Metrics       `json:"metrics,omitempty"`
}

Node describes a superset of the metadata that probes can collect about a given node in a given topology, along with the edges emanating from the node and metadata about those edges.

func MakeNode added in v0.7.0 

func MakeNode() Node

MakeNode creates a new Node with no initial metadata.

func MakeNodeWith added in v0.7.0 

func MakeNodeWith(m map[string]string) Node

MakeNodeWith creates a new Node with the supplied map.

func (Node) Copy added in v0.7.0 

func (n Node) Copy() Node

Copy returns a value copy of the Node.

func (Node) Merge added in v0.7.0 

func (n Node) Merge(other Node) Node

Merge mergses the individual components of a node and returns a fresh node.

func (Node) WithAdjacent added in v0.7.0 

func (n Node) WithAdjacent(a ...string) Node

WithAdjacent returns a fresh copy of n, with 'a' added to Adjacency

func (Node) WithControls added in v0.10.0 

func (n Node) WithControls(cs ...string) Node

WithControls returns a fresh copy of n, with cs added to Controls.

func (Node) WithCounters added in v0.7.0 

func (n Node) WithCounters(c map[string]int) Node

WithCounters returns a fresh copy of n, with Counters c merged in.

func (Node) WithEdge added in v0.7.0 

func (n Node) WithEdge(dst string, md EdgeMetadata) Node

WithEdge returns a fresh copy of n, with 'dst' added to Adjacency and md added to EdgeMetadata.

func (Node) WithLatest added in v0.10.0 

func (n Node) WithLatest(k string, ts time.Time, v string) Node

WithLatest produces a new Node with k mapped to v in the Latest metadata.

func (Node) WithMetadata added in v0.7.0 

func (n Node) WithMetadata(m map[string]string) Node

WithMetadata returns a fresh copy of n, with Metadata m merged in.

func (Node) WithMetric added in v0.10.0 

func (n Node) WithMetric(key string, metric Metric) Node

WithMetric returns a fresh copy of n, with metric merged in at key.

func (Node) WithMetrics added in v0.10.0 

func (n Node) WithMetrics(metrics Metrics) Node

WithMetrics returns a fresh copy of n, with metrics merged in.

func (Node) WithSet added in v0.10.0 

func (n Node) WithSet(key string, set StringSet) Node

WithSet returns a fresh copy of n, with set merged in at key.

func (Node) WithSets added in v0.10.0 

func (n Node) WithSets(sets Sets) Node

WithSets returns a fresh copy of n, with sets merged in.

type NodeControls added in v0.10.0 

type NodeControls struct {
	Timestamp time.Time `json:"timestamp"`
	Controls  StringSet `json:"controls,omitempty"`
}

NodeControls represent the individual controls that are valid for a given node at a given point in time. Its is immutable. A zero-value for Timestamp indicated this NodeControls is 'not set'.

func MakeNodeControls added in v0.10.0 

func MakeNodeControls() NodeControls

MakeNodeControls makes a new NodeControls

func (NodeControls) Add added in v0.10.0 

func (nc NodeControls) Add(ids ...string) NodeControls

Add the new control IDs to this NodeControls, producing a fresh NodeControls.

func (NodeControls) Copy added in v0.10.0 

func (nc NodeControls) Copy() NodeControls

Copy is a noop, as NodeControls is immutable

func (NodeControls) Merge added in v0.10.0 

func (nc NodeControls) Merge(other NodeControls) NodeControls

Merge returns the newest of the two NodeControls; it does not take the union of the valid Controls.

type Nodes added in v0.7.0 

type Nodes map[string]Node

Nodes is a collection of nodes in a topology. Keys are node IDs. TODO(pb): type Topology map[string]Node

func (Nodes) Copy added in v0.7.0 

func (n Nodes) Copy() Nodes

Copy returns a value copy of the Nodes.

func (Nodes) Merge added in v0.7.0 

func (n Nodes) Merge(other Nodes) Nodes

Merge merges the other object into this one, and returns the result object. The original is not modified.

type Report 

type Report struct {
	// Endpoint nodes are individual (address, port) tuples on each host.
	// They come from inspecting active connections and can (theoretically)
	// be traced back to a process. Edges are present.
	Endpoint Topology

	// Address nodes are addresses (e.g. ifconfig) on each host. Certain
	// information may be present in this topology that can't be mapped to
	// endpoints (e.g. ICMP). Edges are present.
	Address Topology

	// Process nodes are processes on each host. Edges are not present.
	Process Topology

	// Container nodes represent all Docker containers on hosts running probes.
	// Metadata includes things like containter id, name, image id etc.
	// Edges are not present.
	Container Topology

	// Pod nodes represent all Kubernetes pods running on hosts running probes.
	// Metadata includes things like pod id, name etc. Edges are not
	// present.
	Pod Topology

	// Service nodes represent all Kubernetes services running on hosts running probes.
	// Metadata includes things like service id, name etc. Edges are not
	// present.
	Service Topology

	// ContainerImages nodes represent all Docker containers images on
	// hosts running probes. Metadata includes things like image id, name etc.
	// Edges are not present.
	ContainerImage Topology

	// Host nodes are physical hosts that run probes. Metadata includes things
	// like operating system, load, etc. The information is scraped by the
	// probes with each published report. Edges are not present.
	Host Topology

	// Overlay nodes are active peers in any software-defined network that's
	// overlaid on the infrastructure. The information is scraped by polling
	// their status endpoints. Edges could be present, but aren't currently.
	Overlay Topology

	// Sampling data for this report.
	Sampling Sampling

	// Window is the amount of time that this report purports to represent.
	// Windows must be carefully merged. They should only be added when
	// reports cover non-overlapping periods of time. By default, we assume
	// that's true, and add windows in merge operations. When that's not true,
	// such as in the app, we expect the component to overwrite the window
	// before serving it to consumers.
	Window time.Duration

	// Shortcut reports should be propogated to the UI as quickly as possible,
	// bypassing the usual spy interval, publish interval and app ws interval.
	Shortcut bool
}

Report is the core data type. It's produced by probes, and consumed and stored by apps. It's composed of multiple topologies, each representing a different (related, but not equivalent) view of the network.

func MakeReport added in v0.3.0 

func MakeReport() Report

MakeReport makes a clean report, ready to Merge() other reports into.

func (Report) Copy added in v0.7.0 

func (r Report) Copy() Report

Copy returns a value copy of the report.

func (Report) Merge 

func (r Report) Merge(other Report) Report

Merge merges another Report into the receiver and returns the result. The original is not modified.

func (Report) Topologies added in v0.3.0 

func (r Report) Topologies() []Topology

Topologies returns a slice of Topologies in this report

func (Report) Validate added in v0.3.0 

func (r Report) Validate() error

Validate checks the report for various inconsistencies.

type Sample added in v0.10.0 

type Sample struct {
	Timestamp time.Time `json:"date"`
	Value     float64   `json:"value"`
}

Sample is a single datapoint of a metric.

type Sampling added in v0.6.0 

type Sampling struct {
	Count uint64 // observed and processed
	Total uint64 // observed overall
}

Sampling describes how the packet data sources for this report were sampled. It can be used to calculate effective sample rates. We can't just put the rate here, because that can't be accurately merged. Counts in e.g. edge metadata structures have already been adjusted to compensate for the sample rate.

func (Sampling) Merge added in v0.6.0 

func (s Sampling) Merge(other Sampling) Sampling

Merge combines two sampling structures via simple addition and returns the result. The original is not modified.

func (Sampling) Rate added in v0.6.0 

func (s Sampling) Rate() float64

Rate returns the effective sampling rate.

type Sets added in v0.10.0 

type Sets map[string]StringSet

Sets is a string->set-of-strings map.

func (Sets) Copy added in v0.10.0 

func (s Sets) Copy() Sets

Copy returns a value copy of the sets map.

func (Sets) Merge added in v0.10.0 

func (s Sets) Merge(other Sets) Sets

Merge merges two sets maps into a fresh set, performing set-union merges as appropriate.

type StringSet added in v0.10.0 

type StringSet []string

StringSet is a sorted set of unique strings. Clients must use the Add method to add strings.

func MakeStringSet added in v0.10.0 

func MakeStringSet(strs ...string) StringSet

MakeStringSet makes a new StringSet with the given strings.

func (StringSet) Add added in v0.10.0 

func (s StringSet) Add(strs ...string) StringSet

Add adds the strings to the StringSet. Add is the only valid way to grow a StringSet. Add returns the StringSet to enable chaining.

func (StringSet) Copy added in v0.10.0 

func (s StringSet) Copy() StringSet

Copy returns a value copy of the StringSet.

func (StringSet) Merge added in v0.10.0 

func (s StringSet) Merge(other StringSet) StringSet

Merge combines the two StringSets and returns a new result.

type Topology 

type Topology struct {
	Nodes // TODO(pb): remove Nodes intermediate type
	Controls
}

Topology describes a specific view of a network. It consists of nodes and edges, and metadata about those nodes and edges, represented by EdgeMetadatas and Nodes respectively. Edges are directional, and embedded in the Node struct.

func MakeTopology added in v0.7.0 

func MakeTopology() Topology

MakeTopology gives you a Topology.

func (Topology) AddNode added in v0.7.0 

func (t Topology) AddNode(nodeID string, nmd Node) Topology

AddNode adds node to the topology under key nodeID; if a node already exists for this key, nmd is merged with that node. The same topology is returned to enable chaining. This method is different from all the other similar methods in that it mutates the Topology, to solve issues of GC pressure.

func (Topology) Copy added in v0.7.0 

func (t Topology) Copy() Topology

Copy returns a value copy of the Topology.

func (Topology) Merge 

func (t Topology) Merge(other Topology) Topology

Merge merges the other object into this one, and returns the result object. The original is not modified.

func (Topology) Validate added in v0.3.0 

func (t Topology) Validate() error

Validate checks the topology for various inconsistencies.

type WireMetrics added in v0.10.0 

type WireMetrics struct {
	Samples []Sample `json:"samples"` // On the wire, samples are sorted oldest to newest,
	Min     float64  `json:"min"`     // the opposite order to how we store them internally.
	Max     float64  `json:"max"`
	First   string   `json:"first,omitempty"`
	Last    string   `json:"last,omitempty"`
}

WireMetrics is the on-the-wire representation of Metrics.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.