Package org.apache.beam.sdk.options

Interface MemoryMonitorOptions

All Superinterfaces:

HasDisplayData, PipelineOptions

All Known Subinterfaces:

DataflowPipelineDebugOptions, DataflowPipelineOptions, DataflowWorkerHarnessOptions, SdkHarnessOptions, TestDataflowPipelineOptions

public interface MemoryMonitorOptions
extends PipelineOptions

Options that are used to control the Memory Monitor.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.beam.sdk.options.PipelineOptions

PipelineOptions.AtomicLongFactory, PipelineOptions.CheckEnabled, PipelineOptions.DirectRunner, PipelineOptions.JobNameFactory, PipelineOptions.UserAgentFactory

Method Summary

Modifier and Type	Method	Description
Double	getGCThrashingPercentagePerPeriod()	The GC thrashing threshold percentage.
boolean	getGzipCompressHeapDumps()	Controls if heap dumps that are copied to remote destination are gzipped compressed.
String	getRemoteHeapDumpLocation()	A remote file system to upload captured heap dumps to.
void	setGCThrashingPercentagePerPeriod(Double value)
void	setGzipCompressHeapDumps(boolean value)
void	setRemoteHeapDumpLocation(String value)

Methods inherited from interface org.apache.beam.sdk.transforms.display.HasDisplayData

populateDisplayData

Methods inherited from interface org.apache.beam.sdk.options.PipelineOptions

as, getJobName, getOptionsId, getRunner, getStableUniqueNames, getTempLocation, getUserAgent, outputRuntimeOptions, revision, setJobName, setOptionsId, setRunner, setStableUniqueNames, setTempLocation, setUserAgent

Method Details

getGCThrashingPercentagePerPeriod

@Double(50.0)
Double getGCThrashingPercentagePerPeriod()

The GC thrashing threshold percentage. A given period of time is considered "thrashing" if this percentage of CPU time is spent in garbage collection. Harness will force fail tasks after sustained periods of thrashing.

If 100 is given as the value, MemoryMonitor will be disabled.

setGCThrashingPercentagePerPeriod

void setGCThrashingPercentagePerPeriod(Double value)

getRemoteHeapDumpLocation

String getRemoteHeapDumpLocation()

A remote file system to upload captured heap dumps to. If not provided defaults to --tempLocation.

This can be a path of any file system.

setRemoteHeapDumpLocation

void setRemoteHeapDumpLocation(String value)

getGzipCompressHeapDumps

@Boolean(true)
boolean getGzipCompressHeapDumps()

Controls if heap dumps that are copied to remote destination are gzipped compressed. This can greatly reduce the data copied and speed up the time to copy heap dumps.

setGzipCompressHeapDumps

void setGzipCompressHeapDumps(boolean value)