Skip to content
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.

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

Dump Heap on OOM and Retain Heap Dump #18392

Merged
merged 36 commits into from
Sep 14, 2021

Conversation

alzimmermsft
Copy link
Member

@alzimmermsft alzimmermsft commented Dec 29, 2020

This PR adds support for CI pipelines to dump heap on OutOfMemoryError and retain the hprof as a pipeline artifact. Additionally, this introduces a new pattern for configuring maven-surefire-plugin's argLine configuration.

@alzimmermsft alzimmermsft added EngSys This issue is impacting the engineering system. common common module used by all azure SDKs (e.g. client, Mgmt) labels Dec 29, 2020
@alzimmermsft alzimmermsft self-assigned this Dec 29, 2020
@alzimmermsft
Copy link
Member Author

/azp run java - core

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@check-enforcer
Copy link

This pull request is protected by Check Enforcer.

What is Check Enforcer?

Check Enforcer helps ensure all pull requests are covered by at least one check-run (typically an Azure Pipeline). When all check-runs associated with this pull request pass then Check Enforcer itself will pass.

Why am I getting this message?

You are getting this message because Check Enforcer did not detect any check-runs being associated with this pull request within five minutes. This may indicate that your pull request is not covered by any pipelines and so Check Enforcer is correctly blocking the pull request being merged.

What should I do now?

If the check-enforcer check-run is not passing and all other check-runs associated with this PR are passing (excluding license-cla) then you could try telling Check Enforcer to evaluate your pull request again. You can do this by adding a comment to this pull request as follows:
/check-enforcer evaluate
Typically evaulation only takes a few seconds. If you know that your pull request is not covered by a pipeline and this is expected you can override Check Enforcer using the following command:
/check-enforcer override
Note that using the override command triggers alerts so that follow-up investigations can occur (PRs still need to be approved as normal).

What if I am onboarding a new service?

Often, new services do not have validation pipelines associated with them, in order to bootstrap pipelines for a new service, you can issue the following command as a pull request comment:
/azp run prepare-pipelines
This will run a pipeline that analyzes the source tree and creates the pipelines necessary to build and validate your pull request. Once the pipeline has been created you can trigger the pipeline using the following comment:
/azp run java - [service] - ci

@JonathanGiles
Copy link
Member

@alzimmermsft status update?

@alzimmermsft
Copy link
Member Author

/azp run java - core

@azure-pipelines
Copy link

Azure Pipelines successfully started running 1 pipeline(s).

@joshfree joshfree added this to the Backlog milestone Aug 30, 2021
@alzimmermsft alzimmermsft merged commit adea924 into Azure:main Sep 14, 2021
@alzimmermsft alzimmermsft deleted the AzEng_RetainHeapDumpOnOoM branch September 14, 2021 19:37
Comment on lines +113 to +117
<!-- This property determines the max heap size of the Surefire JVM. By default 3GB, or 3096MB, is used. -->
<surefireXmx>3096m</surefireXmx>

<!-- This property configures the max heap size of the Surefire JVM. -->
<surefireJvmXmx>-Xmx${surefireXmx}</surefireJvmXmx>
Copy link
Contributor

Choose a reason for hiding this comment

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

can this collide with

<argLine>
-Xmx6g
</argLine>

?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, this can collide with that. The thought behind the new pattern is to override <surefireXmx>3096m</surefireXmx> to a new value in the child POM, so in this case it would be <surefireXmx>6g</surefireXmx> in azure-storage-blob/pom.xml. This will then be rolled into the <surefireJvmXmx> value and passed into the maven-surefire-plugin argLine.

Overall, the changes are to use more composition-esque styling by overriding property values instead of overriding plugin configurations (as these have shown to be much more brittle).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
common common module used by all azure SDKs (e.g. client, Mgmt) EngSys This issue is impacting the engineering system.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

7 participants