pipelinerunmetrics

Documentation

Index

• Constants
• func OnStore(logger *zap.SugaredLogger, r *Recorder) func(name string, value interface{})
• func WithClient(ctx context.Context) context.Context
• func WithInformer(ctx context.Context) (context.Context, controller.Informer)
• type InformerKey
• type Recorder
  • func Get(ctx context.Context) *Recorder
  • func NewRecorder(ctx context.Context) (*Recorder, error)
  • func (r *Recorder) DurationAndCount(pr *v1.PipelineRun, beforeCondition *apis.Condition) error
  • func (r *Recorder) ReportRunningPipelineRuns(ctx context.Context, lister listers.PipelineRunLister)
  • func (r *Recorder) RunningPipelineRuns(lister listers.PipelineRunLister) error
• type RecorderKey

Constants

const (
	// ReasonCancelled indicates that a PipelineRun was cancelled.
	// Aliased for backwards compatibility; additional reasons should not be added here.
	ReasonCancelled = v1.PipelineRunReasonCancelled
)

Functions

func OnStore

func OnStore(logger *zap.SugaredLogger, r *Recorder) func(name string,
	value interface{})

OnStore returns a function that checks if metrics are configured for a config.Store, and registers it if so

func WithClient

func WithClient(ctx context.Context) context.Context

WithClient adds a metrics recorder to the given context

func WithInformer

func WithInformer(ctx context.Context) (context.Context, controller.Informer)

WithInformer returns the given context, and a configured informer

Types

type InformerKey

type InformerKey struct{}

InformerKey is used for associating the Informer inside the context.Context.

type Recorder

type Recorder struct {
	ReportingPeriod time.Duration
	// contains filtered or unexported fields
}

Recorder holds keys for Tekton metrics

func Get

func Get(ctx context.Context) *Recorder

Get extracts the pipelinerunmetrics.Recorder from the context.

func NewRecorder

func NewRecorder(ctx context.Context) (*Recorder, error)

NewRecorder creates a new metrics recorder instance to log the PipelineRun related metrics

func (*Recorder) DurationAndCount

func (r *Recorder) DurationAndCount(pr *v1.PipelineRun, beforeCondition *apis.Condition) error

DurationAndCount logs the duration of PipelineRun execution and count for number of PipelineRuns succeed or failed returns an error if it fails to log the metrics

func (*Recorder) ReportRunningPipelineRuns

func (r *Recorder) ReportRunningPipelineRuns(ctx context.Context, lister listers.PipelineRunLister)

ReportRunningPipelineRuns invokes RunningPipelineRuns on our configured PeriodSeconds until the context is cancelled.

func (*Recorder) RunningPipelineRuns

func (r *Recorder) RunningPipelineRuns(lister listers.PipelineRunLister) error

RunningPipelineRuns logs the number of PipelineRuns running right now returns an error if it fails to log the metrics

type RecorderKey

type RecorderKey struct{}

RecorderKey is used for associating the Recorder inside the context.Context.