harnessopts

Documentation

Overview

Package harnessopts defines user-facing entrypoints into Beam hooks affecting the SDK harness. Call these functions at any time before submitting your pipeline to a runner, for that pipeline's workers to be affected.

Index

• func HeapDumpFrequency(samplingFrequencySeconds, maxTimeBetweenDumpsSeconds int) error
• func SampleInterval(samplePeriod time.Duration) error
• func SideInputCacheCapacity(capacity int64) error

Functions

func HeapDumpFrequency

func HeapDumpFrequency(samplingFrequencySeconds, maxTimeBetweenDumpsSeconds int) error

HeapDumpFrequency sets the sampling frequency for how often the diagnostics service checks if it should take a heap dump and the maximum allowable time between heap dumps. Setting the sampling frequency to <=0 disables the heap dump checks. The default value for the sampling frequency is 1 second, the default max time is 60 seconds.

func SampleInterval

func SampleInterval(samplePeriod time.Duration) error

SampleInterval sets the sampling time period (greater than 1ms) for DoFn metrics sampling. Default value is 200ms.

func SideInputCacheCapacity

func SideInputCacheCapacity(capacity int64) error

SideInputCacheCapacity accepts a desired capacity for the side input cache. A non-zero positive integer enables the cache (the capacity of the cache is 0 by default.) Cache use also requires runner support.