sequence

Documentation

Overview

Package sequence generates protocol sequence diagrams from packet captures.

Index

• type Diagram
  • func NewDiagram(title string) *Diagram
  • func (d *Diagram) AddEvent(e Event)
  • func (d *Diagram) ToMermaid() string
  • func (d *Diagram) ToPlantUML() string
• type Event
• type LatencyStats
  • func ComputeLatency(events []Event) *LatencyStats

Types

type Diagram

type Diagram struct {
	Events []Event
	Title  string
}

Diagram generates sequence diagrams from events.

func NewDiagram

func NewDiagram(title string) *Diagram

NewDiagram creates a new sequence diagram.

func (*Diagram) AddEvent

func (d *Diagram) AddEvent(e Event)

AddEvent adds an event to the diagram.

func (*Diagram) ToMermaid

func (d *Diagram) ToMermaid() string

ToMermaid generates a Mermaid sequence diagram.

func (*Diagram) ToPlantUML

func (d *Diagram) ToPlantUML() string

ToPlantUML generates a PlantUML sequence diagram.

type Event

type Event struct {
	Timestamp float64 `json:"timestamp"`
	Source    string  `json:"source"`
	Dest      string  `json:"dest"`
	Protocol  string  `json:"protocol"`
	Info      string  `json:"info"`
	Latency   float64 `json:"latency_ms,omitempty"`
}

Event represents a protocol event in a sequence.

type LatencyStats

type LatencyStats struct {
	Min   float64 `json:"min_ms"`
	Max   float64 `json:"max_ms"`
	Avg   float64 `json:"avg_ms"`
	Count int     `json:"count"`
}

LatencyStats computes latency statistics from events.

func ComputeLatency

func ComputeLatency(events []Event) *LatencyStats

ComputeLatency computes request-response latency statistics.