timer

README

timer - Timer Middleware

Arguments

Enable time recording by setting the record argument to true.

- some_pipeline:
    timer:
      record: bool,

The execution time of the pipe will be logged at debug level. You might need to use the -v debug argument to ensure the log entries are actually visible.

TODO:

• use dedicated logging channel to merge timing information into actual output

Documentation

Overview

Package timer provides a middleware that records execution time

Index

• type Middleware
  • func NewMiddleware() Middleware
  • func NewMiddlewareWithProvider(timeProvider timeProvider) Middleware
  • func (timerMiddleware Middleware) Apply(run *pipeline.Run, next func(*pipeline.Run), _ *middleware.ExecutionContext)
  • func (timerMiddleware Middleware) String() string

Types

type Middleware

type Middleware struct {
	// contains filtered or unexported fields
}

Middleware is an execution time recorder

func NewMiddleware

func NewMiddleware() Middleware

NewMiddleware creates a new middleware instance

func NewMiddlewareWithProvider

func NewMiddlewareWithProvider(timeProvider timeProvider) Middleware

NewMiddlewareWithProvider creates a new middleware instance with the specified time provider

func (Middleware) Apply

func (timerMiddleware Middleware) Apply(
	run *pipeline.Run,
	next func(*pipeline.Run),
	_ *middleware.ExecutionContext,
)

Apply is where the middleware's logic resides

It adapts the run based on its slice of the run's arguments. It may also trigger side effects such as executing shell commands or full runs of other pipelines. When done, this function should call next in order to continue unwinding the stack.

func (Middleware) String

func (timerMiddleware Middleware) String() string

String is a human-readable description