Skip to content

armgit / solr

Public Imported from GitHub
0

Apache Solr open-source search software

SOLR-8803: Some doc changes. More is needed for docker.

Shawn Heiseya3374039860a
diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/jvm-settings.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/jvm-settings.adoc
index d1217258a63..a40cdc4073e 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/jvm-settings.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/jvm-settings.adoc
@@ -49,9 +49,9 @@ When heaps grow to larger sizes, it is imperative to test extensively before goi
It is often better in these cases to run multiple JVMs, each with a limited amount of memory allocated to their heaps.
One way to achieve this is to run Solr as a https://hub.docker.com/_/solr?tab=tags[Docker container].
* It's good practice to periodically re-analyze the GC logs and/or monitor with xref:metrics-reporting.adoc[] to see if the memory usage has changed due to changes in your application, number of documents, etc.
-* On *nix systems, Solr will run with "OOM killer script" (see `solr/bin/oom_solr.sh`).
-This will forcefully stop Solr when the heap is exhausted rather than continue in an indeterminate state.
-You can additionally request a heap dump on OOM through the values in `solr.in.sh`
+* Solr will run with an option that causes the JVM to crash on OutOfMemoryError exceptions.
+This will forcefully stop Solr when a system resource is exhausted rather than continue in an indeterminate state.
+You can additionally request a heap dump on OOME through the values in `solr.in.sh`
* All current (Java 11) garbage collectors can hit "stop the world" collections, which suspend the JVM until completed.
If, through monitoring, these garbage collections are frequent and greater than your application can tolerate, additional tuning should be considered.
"Stop the world" pauses greater than 5 seconds are rarely acceptable, and having them be less than 1 second is desirable.
diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc
index 364a195d14a..bab49a5dfea 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc
@@ -248,12 +248,10 @@ For more information about garbage collection settings refer to following articl
You can also refer to xref:jvm-settings.adoc[] for tuning your memory and garbage collection settings.
-==== Out-of-Memory Shutdown Hook
+==== Out-of-Memory Handling
-The `bin/solr` script registers the `bin/oom_solr.sh` script to be called by the JVM if an OutOfMemoryError occurs.
-The `oom_solr.sh` script will issue a `kill -9` to the Solr process that experiences the `OutOfMemoryError`.
-This behavior is recommended when running in SolrCloud mode so that ZooKeeper is immediately notified that a node has experienced a non-recoverable error.
-Take a moment to inspect the contents of the `/opt/solr/bin/oom_solr.sh` script so that you are familiar with the actions the script will perform if it is invoked by the JVM.
+The `bin/solr` script uses the `-XX:+CrashOnOutOfMemoryError` JVM option to crash Solr on `OutOfMemoryError` exceptions.
+This behavior is recommended. In SolrCloud mode ZooKeeper will be immediately notified that a node has experienced a non-recoverable error.
=== Going to Production with SolrCloud