taskrunmetrics

Documentation

Index

• func IsPartOfPipeline(tr *v1.TaskRun) (bool, string, string)
• 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(ctx context.Context, tr *v1.TaskRun, beforeCondition *apis.Condition) error
  • func (r *Recorder) RecordPodLatency(ctx context.Context, pod *corev1.Pod, tr *v1.TaskRun) error
  • func (r *Recorder) ReportRunningTaskRuns(ctx context.Context, lister listers.TaskRunLister)
  • func (r *Recorder) RunningTaskRuns(ctx context.Context, lister listers.TaskRunLister) error
• type RecorderKey

Functions

func IsPartOfPipeline

func IsPartOfPipeline(tr *v1.TaskRun) (bool, string, string)

IsPartOfPipeline return true if TaskRun is a part of a Pipeline. It also return the name of Pipeline and PipelineRun

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 is used to actually record TaskRun metrics

func Get

func Get(ctx context.Context) *Recorder

Get extracts the taskrunmetrics.Recorder from the context.

func NewRecorder

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

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

func (*Recorder) DurationAndCount

func (r *Recorder) DurationAndCount(ctx context.Context, tr *v1.TaskRun, beforeCondition *apis.Condition) error

DurationAndCount logs the duration of TaskRun execution and count for number of TaskRuns succeed or failed returns an error if its failed to log the metrics

func (*Recorder) RecordPodLatency

func (r *Recorder) RecordPodLatency(ctx context.Context, pod *corev1.Pod, tr *v1.TaskRun) error

RecordPodLatency logs the duration required to schedule the pod for TaskRun returns an error if its failed to log the metrics

func (*Recorder) ReportRunningTaskRuns

func (r *Recorder) ReportRunningTaskRuns(ctx context.Context, lister listers.TaskRunLister)

ReportRunningTaskRuns invokes RunningTaskRuns on our configured PeriodSeconds until the context is cancelled.

func (*Recorder) RunningTaskRuns

func (r *Recorder) RunningTaskRuns(ctx context.Context, lister listers.TaskRunLister) error

RunningTaskRuns logs the number of TaskRuns running right now returns an error if its failed to log the metrics

type RecorderKey

type RecorderKey struct{}

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