singlerun

Documentation

Overview

Package singlerun provides utilities to handle results of a single run.

Index

• func FormatProbeRunResults(probeResults map[string][]*ProbeRunResult, format Format, indent string) string
• func ProbeRunResultsToProto(results map[string][]*ProbeRunResult) map[string]*pb.ProbeResults
• type Format
• type ProbeRunResult

Functions

func FormatProbeRunResults

func FormatProbeRunResults(probeResults map[string][]*ProbeRunResult, format Format, indent string) string

FormatProbeRunResults formats probe run results into text or JSON. The indent string is used for pretty-printing.

func ProbeRunResultsToProto

func ProbeRunResultsToProto(results map[string][]*ProbeRunResult) map[string]*pb.ProbeResults

ProbeRunResultsToProto converts probe run results to their protobuf form.

Types

type Format

type Format string

Format specifies the format of the output.

const (
	FormatText Format = "text"
	FormatJSON Format = "json"
)

type ProbeRunResult

type ProbeRunResult struct {
	Target  endpoint.Endpoint
	Metrics []*metrics.EventMetrics
	Success bool // Did probe run succeed?
	Latency time.Duration
	Error   error
}

ProbeRunResult encapsulates the results of a single probe run for a specific target.