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

Rewrite error message when Pantsd is shut down during run (Cherry-pick of #12107) #12117

Merged
merged 2 commits into from
May 25, 2021

Conversation

Eric-Arellano
Copy link
Contributor

Users don't know what Nailgun is, which is an implementation detail. We should mention Pantsd so that they have some context what's going on, along with suggesting the possibility of OOM kills and a possible remedy.

Before:

native_engine.NailgunClientException: Nailgun client error: "Nailgun client error: Client exited before the server's result could be returned."

After:

native_engine.PantsdClientException: the pantsd process was killed during the run.

If this was not intentionally done by you, Pants may have been killed by the operating system due to memory overconsumption (i.e. OOM-killed). You can set the global option --pantsd-max-memory-usage to reduce Pantsd's memory consumption by retaining less in its in-memory cache (run ./pants help-advanced global). You can also disable pantsd with the global option --pantsd to avoid persisting memory across Pants runs, although you will miss out on additional caching.

If neither of those help, please consider filing a GitHub issue or reaching out on Slack so that we can investigate the possible memory overconsumption (https://www.pantsbuild.org/docs/getting-help).

[ci skip-build-wheels]

…#12107)

Users don't know what Nailgun is, which is an implementation detail. We should mention Pantsd so that they have some context what's going on, along with suggesting the possibility of OOM kills and a possible remedy.

Before:

> native_engine.NailgunClientException: Nailgun client error: "Nailgun client error: Client exited before the server\'s result could be returned."

After:

> native_engine.PantsdClientException: the pantsd process was killed during the run.
>
> If this was not intentionally done by you, Pants may have been killed by the operating system due to memory overconsumption (i.e. OOM-killed). You can set the global option `--pantsd-max-memory-usage` to reduce Pantsd's memory consumption by retaining less in its in-memory cache (run `./pants help-advanced global`). You can also disable pantsd with the global option `--pantsd` to avoid persisting memory across Pants runs, although you will miss out on additional caching.
>
> If neither of those help, please consider filing a GitHub issue or reaching out on Slack so that we can investigate the possible memory overconsumption (https://www.pantsbuild.org/docs/getting-help).

[ci skip-build-wheels]
@Eric-Arellano Eric-Arellano requested a review from tdyas May 24, 2021 23:23
…ilure-24

[ci skip-rust]

[ci skip-build-wheels]
@Eric-Arellano Eric-Arellano merged commit 3797f94 into pantsbuild:2.4.x May 25, 2021
@Eric-Arellano Eric-Arellano deleted the cp-pantsd-failure-24 branch May 25, 2021 03:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant