mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-28 17:34:17 -04:00
9671cabefc
The docs introduced in #91333 apply to older versions in which the `systemd` startup timeout was 75s by default, but in #91338 we extended the `systemd` startup timeout to 900s from 8.7.0 and 7.17.8 onwards. This commit adjusts the docs to match.
102 lines
4 KiB
Text
102 lines
4 KiB
Text
==== Running Elasticsearch with `systemd`
|
|
|
|
To configure Elasticsearch to start automatically when the system boots up,
|
|
run the following commands:
|
|
|
|
[source,sh]
|
|
--------------------------------------------------
|
|
sudo /bin/systemctl daemon-reload
|
|
sudo /bin/systemctl enable elasticsearch.service
|
|
--------------------------------------------------
|
|
|
|
Elasticsearch can be started and stopped as follows:
|
|
|
|
[source,sh]
|
|
--------------------------------------------
|
|
sudo systemctl start elasticsearch.service
|
|
sudo systemctl stop elasticsearch.service
|
|
--------------------------------------------
|
|
|
|
These commands provide no feedback as to whether Elasticsearch was started
|
|
successfully or not. Instead, this information will be written in the log
|
|
files located in `/var/log/elasticsearch/`.
|
|
|
|
If you have password-protected your {es} keystore, you will need to provide
|
|
`systemd` with the keystore password using a local file and systemd environment
|
|
variables. This local file should be protected while it exists and may be
|
|
safely deleted once Elasticsearch is up and running.
|
|
|
|
[source,sh]
|
|
-----------------------------------------------------------------------------------
|
|
echo "keystore_password" > /path/to/my_pwd_file.tmp
|
|
chmod 600 /path/to/my_pwd_file.tmp
|
|
sudo systemctl set-environment ES_KEYSTORE_PASSPHRASE_FILE=/path/to/my_pwd_file.tmp
|
|
sudo systemctl start elasticsearch.service
|
|
-----------------------------------------------------------------------------------
|
|
|
|
By default the Elasticsearch service doesn't log information in the `systemd`
|
|
journal. To enable `journalctl` logging, the `--quiet` option must be removed
|
|
from the `ExecStart` command line in the `elasticsearch.service` file.
|
|
|
|
When `systemd` logging is enabled, the logging information are available using
|
|
the `journalctl` commands:
|
|
|
|
To tail the journal:
|
|
|
|
[source,sh]
|
|
--------------------------------------------
|
|
sudo journalctl -f
|
|
--------------------------------------------
|
|
|
|
To list journal entries for the elasticsearch service:
|
|
|
|
[source,sh]
|
|
--------------------------------------------
|
|
sudo journalctl --unit elasticsearch
|
|
--------------------------------------------
|
|
|
|
To list journal entries for the elasticsearch service starting from a given time:
|
|
|
|
[source,sh]
|
|
--------------------------------------------
|
|
sudo journalctl --unit elasticsearch --since "2016-10-30 18:17:16"
|
|
--------------------------------------------
|
|
|
|
Check `man journalctl` or https://www.freedesktop.org/software/systemd/man/journalctl.html for
|
|
more command line options.
|
|
|
|
[TIP]
|
|
.Startup timeouts with older `systemd` versions
|
|
====
|
|
By default {es} sets the `TimeoutStartSec` parameter to `systemd` to `900s`. If
|
|
you are running at least version 238 of `systemd` then {es} can automatically
|
|
extend the startup timeout, and will do so repeatedly until startup is complete
|
|
even if it takes longer than 900s.
|
|
|
|
Versions of `systemd` prior to 238 do not support the timeout extension
|
|
mechanism and will terminate the {es} process if it has not fully started up
|
|
within the configured timeout. If this happens, {es} will report in its logs
|
|
that it was shut down normally a short time after it started:
|
|
|
|
[source,text]
|
|
-------------
|
|
[2022-01-31T01:22:31,077][INFO ][o.e.n.Node ] [instance-0000000123] starting ...
|
|
...
|
|
[2022-01-31T01:37:15,077][INFO ][o.e.n.Node ] [instance-0000000123] stopping ...
|
|
-------------
|
|
|
|
However the `systemd` logs will report that the startup timed out:
|
|
|
|
[source,text]
|
|
-------------
|
|
Jan 31 01:22:30 debian systemd[1]: Starting Elasticsearch...
|
|
Jan 31 01:37:15 debian systemd[1]: elasticsearch.service: Start operation timed out. Terminating.
|
|
Jan 31 01:37:15 debian systemd[1]: elasticsearch.service: Main process exited, code=killed, status=15/TERM
|
|
Jan 31 01:37:15 debian systemd[1]: elasticsearch.service: Failed with result 'timeout'.
|
|
Jan 31 01:37:15 debian systemd[1]: Failed to start Elasticsearch.
|
|
-------------
|
|
|
|
To avoid this, upgrade your `systemd` to at least version 238. You can also
|
|
temporarily work around the problem by extending the `TimeoutStartSec`
|
|
parameter.
|
|
====
|