Skip to content

Add availability info for default heap dump path change #131713

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

shainaraskas
Copy link
Contributor

Followup to #124966

This PR adds availability information for the change to the default jvm heap dump path. used tabs to provide detailed path information for both logs and data

Docs are now cumulative, which means that we need to clearly tag changes introduced in each version going forward, and keep docs valid for users still using older versions.

image

@shainaraskas shainaraskas requested review from rjernst and a team July 22, 2025 17:32
@shainaraskas shainaraskas added >docs General docs changes Team:Docs Meta label for docs team auto-backport Automatically create backport pull requests when merged v9.1.0 labels Jul 22, 2025
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

Copy link
Contributor

🔍 Preview links for changed docs

Copy link
Member

@rjernst rjernst left a comment

Choose a reason for hiding this comment

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

Looks good, but the change is also in 8.19

By default, {{es}} configures the JVM to dump the heap on out of memory exceptions to the default logs directory. On [RPM](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-rpm.md) and [Debian](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-debian-package.md) packages, the logs directory is `/var/log/elasticsearch`. On [Linux and MacOS](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-from-archive-on-linux-macos.md) and [Windows](docs-content://deploy-manage/deploy/self-managed/install-elasticsearch-with-zip-on-windows.md) distributions, the `logs` directory is located under the root of the {{es}} installation.
Depending on your stack version, {{es}} configures the JVM to dump the heap on out of memory exceptions to the following location by default:

* {applies_to}`stack: ga 9.1` The default logs directory
Copy link
Member

Choose a reason for hiding this comment

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

This should also include 8.19?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

this docs set only applies to 9.0+, but I agree that it is confusing. let me see if there's something I'm able to do.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

verified that we need to keep the 8.x and 9.x docs separate - this info should be manually backported into the asciidoc docs in the 8.19 branch.

will likely be doing a validation pass that the changes that are making it into 8.19 were appropriately ported but haven't gotten there yet :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
auto-backport Automatically create backport pull requests when merged >docs General docs changes Team:Docs Meta label for docs team v9.1.0 v9.2.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants