promwrapper

Documentation

Overview

promwrapper wraps another OCR2 reporting plugin and provides standardized prometheus metrics for each of the OCR2 phases (Query, Observation, Report, ShouldAcceptFinalizedReport, ShouldTransmitAcceptedReport, and Close).

Index

• func New(plugin types.ReportingPlugin, name string, chainType string, chainID *big.Int, ...) types.ReportingPlugin
• func NewPromFactory(wrapped types.ReportingPluginFactory, name, chainType string, chainID *big.Int) types.ReportingPluginFactory
• type PrometheusBackend

Functions

func New

func New(
	plugin types.ReportingPlugin,
	name string,
	chainType string,
	chainID *big.Int,
	config types.ReportingPluginConfig,
	backend PrometheusBackend,
) types.ReportingPlugin

func NewPromFactory

func NewPromFactory(wrapped types.ReportingPluginFactory, name, chainType string, chainID *big.Int) types.ReportingPluginFactory

Types

type PrometheusBackend

type PrometheusBackend interface {
	// Intra-phase latency.
	SetQueryDuration([]string, float64)
	SetObservationDuration([]string, float64)
	SetReportDuration([]string, float64)
	SetShouldAcceptFinalizedReportDuration([]string, float64)
	SetShouldTransmitAcceptedReportDuration([]string, float64)
	SetCloseDuration([]string, float64)

	// Inter-phase latency.
	SetQueryToObservationLatency([]string, float64)
	SetObservationToReportLatency([]string, float64)
	SetReportToAcceptFinalizedReportLatency([]string, float64)
	SetAcceptFinalizedReportToTransmitAcceptedReportLatency([]string, float64)
}

Contains interface for logging OCR telemetry.