presentation

Documentation

Overview

Package presentation implements interactive and non-interactive reporting of cache activity.

Index

• type JsonReport
• type StatProvider
• type Stats
  • func (s Stats) Diff(other Stats) Stats
• type StatsSet
• type UIHandler
  • func New(logger log.Logger, analysisPool *analysis.Pool, interval time.Duration, ...) UIHandler

Types

type JsonReport

type JsonReport struct {
	Timestamp                   string
	TotalKeys                   int
	TotalBandwidth              int64
	ReportedKeys                int
	ReportedBandwidth           int64
	ReportedBandwidthPercentage float64
	Rows                        []map[string]interface{}
	Stats                       StatsSet
}

type StatProvider

type StatProvider func() StatsSet

StatProvider returns a snapshot of current runtime statistics.

type Stats

type Stats struct {
	// count of packets that entered the kernel BPF
	PacketsEnteredFilter int `json:"PacketsEnteredFilter"`
	// count of packets that passed the BPF and queued or dropped by the kernel
	PacketsPassedFilter int `json:"PacketsPassedFilter"`
	// count of packets received from pcap
	PacketsCaptured int `json:"PacketsCaptured"`
	// count of packets dropped due to kernel buffer overflow
	PacketsDroppedKernel int `json:"PacketsDroppedKernel"`
	// count of packets dropped due to no decoder available
	PacketsDroppedParser int `json:"PacketsDroppedParser"`
	// count of packets dropped due to analysis queue being full
	PacketsDroppedAnalysis int `json:"PacketsDroppedAnalysis"`
	PacketsDroppedTotal    int `json:"PacketsDroppedTotal"`
	ResponsesParsed        int `json:"ResponsesParsed"`
}

Stats collects statistics on runtime performance to be displayed to the user.

func (Stats) Diff

func (s Stats) Diff(other Stats) Stats

Subtracts other from these original set of stats, returning a new Stats

type StatsSet

type StatsSet struct {
	Culumative  *Stats
	Incremental *Stats
}

type UIHandler

type UIHandler interface {
	// Run starts this UIHandler running.
	// It does not return unless an error occurs.
	Run() error
	// Log displays a log message to the user.
	Log(items ...interface{})
}

UIHandler is the external API for an interactive user interface.

func New

func New(logger log.Logger, analysisPool *analysis.Pool, interval time.Duration, cumulative bool, statProvider StatProvider,
	useTermbox bool, topX uint16, minKeySizeThreshold uint64, outputFile string) UIHandler

New returns a UIHandler that is ready to run