reqctx

Documentation

Index

• Variables
• func Logger(ctx context.Context) *zap.Logger
• func ModuleExecutionTracing(ctx context.Context) bool
• func ReqStats(ctx context.Context) metrics.Stats
• func Tracer(ctx context.Context) ttrace.Tracer
• func WithModuleExecutionTracing(ctx context.Context) context.Context
• func WithReqStats(ctx context.Context, stats metrics.Stats) context.Context
• func WithRequest(ctx context.Context, req *RequestDetails) context.Context
• func WithTracer(ctx context.Context, tracer ttrace.Tracer) context.Context
• type ISpan
  • func Span(ctx context.Context) ISpan
  • func WithModuleExecutionSpan(ctx context.Context, name string) (context.Context, ISpan)
  • func WithSpan(ctx context.Context, name string) (context.Context, ISpan)
• type IsOutputModuleFunc
• type RequestDetails
  • func Details(ctx context.Context) *RequestDetails
  • func (d *RequestDetails) IsOutputModule(modName string) bool
  • func (d *RequestDetails) ShouldReturnProgressMessages() bool
  • func (d *RequestDetails) ShouldReturnWrittenPartials(modName string) bool
  • func (d *RequestDetails) ShouldStreamCachedOutputs() bool
  • func (d *RequestDetails) SkipSnapshotSave(modName string) bool
  • func (d *RequestDetails) UniqueIDString() string
• type TracingConf
  • func NewTracingConf(moduleExecution bool) *TracingConf

Variables

var WithLogger = logging.WithLogger

Functions

func Logger

func Logger(ctx context.Context) *zap.Logger

func ModuleExecutionTracing

func ModuleExecutionTracing(ctx context.Context) bool

func ReqStats

func ReqStats(ctx context.Context) metrics.Stats

func Tracer

func Tracer(ctx context.Context) ttrace.Tracer

func WithModuleExecutionTracing

func WithModuleExecutionTracing(ctx context.Context) context.Context

func WithReqStats

func WithReqStats(ctx context.Context, stats metrics.Stats) context.Context

func WithRequest

func WithRequest(ctx context.Context, req *RequestDetails) context.Context

func WithTracer

func WithTracer(ctx context.Context, tracer ttrace.Tracer) context.Context

Types

type ISpan

type ISpan interface {
	ttrace.Span

	EndWithErr(e *error)
}

func Span

func Span(ctx context.Context) ISpan

func WithModuleExecutionSpan

func WithModuleExecutionSpan(ctx context.Context, name string) (context.Context, ISpan)

func WithSpan

func WithSpan(ctx context.Context, name string) (context.Context, ISpan)

type IsOutputModuleFunc

type IsOutputModuleFunc func(name string) bool

type RequestDetails

type RequestDetails struct {
	Modules *pbsubstreams.Modules

	DebugInitialStoreSnapshotForModules []string
	OutputModule                        string
	// What the user requested, derived from either the Request.StartBlockNum or Request.Cursor
	ResolvedStartBlockNum uint64
	ResolvedCursor        string

	LinearHandoffBlockNum uint64
	StopBlockNum          uint64
	MaxParallelJobs       uint64
	UniqueID              uint64

	ProductionMode bool
	IsSubRequest   bool
}

func Details

func Details(ctx context.Context) *RequestDetails

func (*RequestDetails) IsOutputModule

func (d *RequestDetails) IsOutputModule(modName string) bool

func (*RequestDetails) ShouldReturnProgressMessages

func (d *RequestDetails) ShouldReturnProgressMessages() bool

func (*RequestDetails) ShouldReturnWrittenPartials

func (d *RequestDetails) ShouldReturnWrittenPartials(modName string) bool

func (*RequestDetails) ShouldStreamCachedOutputs

func (d *RequestDetails) ShouldStreamCachedOutputs() bool

func (*RequestDetails) SkipSnapshotSave

func (d *RequestDetails) SkipSnapshotSave(modName string) bool

Called to determine if we *really* need to save this store snapshot. We don't need when we're doing parallel processing and we are concerned only with writing the leaf stores we've been asked to produce. We know the scheduler will have created jobs to produce those stores we're skipping here.

func (*RequestDetails) UniqueIDString

func (d *RequestDetails) UniqueIDString() string

type TracingConf

type TracingConf struct {
	ModuleExecution bool
}

func NewTracingConf

func NewTracingConf(
	moduleExecution bool,
) *TracingConf