Enable Temporal to startup even if Elastic Search is down #866
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
mastermanu
changed the title
…fix_temporal_startup_if_es_down
markmark206
reviewed
Oct 15, 2020
markmark206
approved these changes
Oct 15, 2020
alexshtin
reviewed
Oct 15, 2020
|
|
||
| // Re-enable the healthcheck after client has successfully been created. | ||
| client.Stop() | ||
| elastic.SetHealthcheck(true)(client) |
alexshtin
approved these changes
Oct 15, 2020
|
FYI, creating yet another env ( |
turns out that the docker "check ES being online" is not only used by all in one setup for dev. |
wxing1292
approved these changes
Oct 15, 2020
…nu/temporal into fix_temporal_startup_if_es_down
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
A customer discovered an issue where Temporal Server will fail to start up if it is using ElasticSearch, and ElasticSearch is down. There are two separate issues:
This PR provides a proper fix for the first issue and a workaround for the second issue.
For the first issue, when we create the ElasticSearch client, we disable health checks, and then re-enable the healthchecks after the client is created. This ensures we can create the client even if ES is down.
For the second issue, we added another environment variable called "$BEST_EFFORT_CREATE_ES_SCHEMA." By default, this is false (meaning if ES is down, startup will block). If the user finds their startup is blocked because of this, they can set the variable to true. With a value of true, the docker script will continue after 30 seconds if it is unable to establish a connection to Elastic Search (we could also parameterize the 30 seconds as well).
We have a task at Temporal tracking the creation of a better story for the second issue.
Tested both fixes using local development environment and auto-setup containers. Also validated that ES catches up once it is started after Temporal has already started.