Skip to content

[BEAM-87] Support opt-in for heap dumps #8

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
mshields822 wants to merge 2 commits into from
Closed

[BEAM-87] Support opt-in for heap dumps #8

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5cd0589
[BEAM-87] Support opt-in for heap dumps
Mar 2, 2016
616f898
Clarrify heap file path.
Mar 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions sdk/src/main/java/com/google/cloud/dataflow/sdk/options/DataflowPipelineDebugOptions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -208,6 +208,20 @@ public Dataflow create(PipelineOptions options) {
int getNumberOfWorkerHarnessThreads();
void setNumberOfWorkerHarnessThreads(int value);

/**
* If {@literal true}, save a heap dump before killing a thread or process which is GC
* thrashing or out of memory. The location of the heap file will either be echoed back
* to the user, or the user will be given the oppourtunity to download the heap file.
*
* <p>
* CAUTION: Heap dumps can of comparable size to the default boot disk. Consider increasing
* the boot disk size before setting this flag to true.
*/
@Description("If {@literal true}, save a heap dump before killing a thread or process "
Copy link
Contributor

@jkff jkff Mar 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could you document where the heap dump will be saved?

Copy link
Contributor Author

@mshields822 mshields822 Mar 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That is runner-specific.

Copy link
Contributor Author

@mshields822 mshields822 Mar 3, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ah, no it isn't - was thrown by path (eventually this should go into a runners/dataflow dir in root).

+ "which is GC thrashing or out of memory.")
boolean getDumpHeapOnOOM();
void setDumpHeapOnOOM(boolean dumpHeapBeforeExit);

/**
* Creates a {@link PathValidator} object using the class specified in
* {@link #getPathValidatorClass()}.
Expand Down