Function AsInstrumented

monitoring/instrumented.go:87–120

AsInstrumented wraps e2e.Runnable with InstrumentedRunnable. If runnable is running during invocation AsInstrumented panics. NOTE(bwplotka): Caller is expected to discard passed `r` runnable and use returned InstrumentedRunnable.Runnable instead.

(r e2e.Runnable, instrumentedPortName string, opts ...InstrumentedOption)

// If runnable is running during invocation AsInstrumented panics.
// NOTE(bwplotka): Caller is expected to discard passed `r` runnable and use returned InstrumentedRunnable.Runnable instead.
func AsInstrumented(r e2e.Runnable, instrumentedPortName string, opts ...InstrumentedOption) *InstrumentedRunnable {
	if r.IsRunning() {
		panic("can't use AsInstrumented with running runnable")
	}

	opt := rOpt{
		metricPath: "/metrics",
		scheme:     "http",
		waitBackoff: backoff.New(context.Background(), backoff.Config{
			Min:        300 * time.Millisecond,
			Max:        600 * time.Millisecond,
			MaxRetries: 50, // Sometimes the CI is slow ¯\_(ツ)_/¯
		})}
	for _, o := range opts {
		o(&opt)
	}

	if r.InternalEndpoint(instrumentedPortName) == "" {
		return &InstrumentedRunnable{Runnable: e2e.NewFailedRunnable(
			r.Name(),
			errors.Newf("metric port name %v does not exists in given runnable ports", instrumentedPortName)),
		}
	}

	instr := &InstrumentedRunnable{
		Runnable:       r,
		metricPortName: instrumentedPortName,
		metricPath:     opt.metricPath,
		scheme:         opt.scheme,
		waitBackoff:    opt.waitBackoff,
	}
	r.SetMetadata(metaKey, Instrumented(instr))
	return instr
}

func (r *InstrumentedRunnable) MetricTargets() []Target {
	return []Target{{Scheme: r.scheme, MetricPath: r.metricPath, InternalEndpoint: r.InternalEndpoint(r.metricPortName)}}