metrics

package

v2.2.0 Latest Latest Go to latest Published: Oct 11, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/form3tech-oss/f1

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Init(iterationMetricsEnabled bool)
func InitWithStaticMetrics(iterationMetricsEnabled bool, staticMetrics map[string]string)
type Metrics
- func Instance() *Metrics
- func NewInstance(registry *prometheus.Registry, iterationMetricsEnabled bool, ...) *Metrics
type ResultType
- func Result(failed bool) ResultType
- func (r ResultType) String() string

Constants ¶

View Source

const (
	TestNameLabel = "test"
	StageLabel    = "stage"
	ResultLabel   = "result"
)

View Source

const IterationStage = "iteration"

Variables ¶

This section is empty.

Functions ¶

func Init ¶ added in v2.1.0

func Init(iterationMetricsEnabled bool)

func InitWithStaticMetrics ¶ added in v2.2.0

func InitWithStaticMetrics(iterationMetricsEnabled bool, staticMetrics map[string]string)

Types ¶

type Metrics ¶

type Metrics struct {
	Setup                   *prometheus.SummaryVec
	Iteration               *prometheus.SummaryVec
	Registry                *prometheus.Registry
	IterationMetricsEnabled bool
	// contains filtered or unexported fields
}

func Instance ¶

func Instance() *Metrics

func NewInstance ¶ added in v2.1.0

func NewInstance(registry *prometheus.Registry,
	iterationMetricsEnabled bool,
	staticMetrics map[string]string,
) *Metrics

func (*Metrics) RecordIterationResult ¶ added in v2.1.0

func (metrics *Metrics) RecordIterationResult(name string, result ResultType, nanoseconds int64)

func (*Metrics) RecordIterationStage ¶ added in v2.1.0

func (metrics *Metrics) RecordIterationStage(name string, stage string, result ResultType, nanoseconds int64)

func (*Metrics) RecordSetupResult ¶ added in v2.1.0

func (metrics *Metrics) RecordSetupResult(name string, result ResultType, nanoseconds int64)

func (*Metrics) Reset ¶

func (metrics *Metrics) Reset()

type ResultType ¶ added in v2.1.0

type ResultType string

const (
	SuccessResult ResultType = "success"
	FailedResult  ResultType = "fail"
	DroppedResult ResultType = "dropped"
	UnknownResult ResultType = "unknown"
)

func Result ¶

func Result(failed bool) ResultType

func (ResultType) String ¶ added in v2.1.0

func (r ResultType) String() string

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL