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

[savedObjects] use index template rather than healthcheck #14142

Closed
wants to merge 36 commits into from

Conversation

spalger
Copy link
Contributor

@spalger spalger commented Sep 23, 2017

WIP

Based on #14141
Fixes #12819

Completely removes SavedObject index management from the health check and to own internal "esAvailability" check.

I’m working on a Kibana feature that will see tens, if not hundreds, of config documents created. Since that is currently the job of the health check and it’s impractical to iterate and check for every expected config document every 2.5 second, we need a more reactive approach; UiSettings should just automatically create the config doc when it doesn’t exist. Unfortunately, we have grown to rely on the health check so much that we often just assume that the Kibana index will always be usable, and we can just write to it without checking, but that really isn’t the case. Writing to the Kibana index without knowing for sure that the index exists is dangerous (see #12819) and the solution recommended by the Elasticearch team is use index templates.

To do this we get rid of the index creation in the healtch check, wrap the callCluster function passed to the SavedObjectCient so that every request to elasticsearch is predicated by a “check”, rather than rely on an interval. This check currently attempts to write an index template to the kibana index (throttled to one attempt per second) when:

  • the first request to elasticsearch is made
  • the elasticsearch plugin goes yellow or red
  • callCluster rejects with a status code >= 500
  • callCluster rejects without a status code
  • a SavedObjectsClient uses its callCluster function after a failed check

We still need to patch the Kibana index if it already exists and we need a 🐃 of tests, but I'm excited by how this is coming along.

The SavedObjects code defines `isEsUsable$` and `testEsAvailability$` to negotiate whether SavedObjectClients should be attempting to communicate to elasticsearch.

  - `isEsUsable$`
    - can be either `undefined`, `true`, or `false`
    - if `isEsUsable === undefined`
      - All requests are paused
    - if `isEsUsable === false`
      - Send 503 to all paused and future requests
    - if `isEsUsable === true`
     - Request are sent to elasticsearch

  - `testEsAvailability$`
    - emits when:
      - elasticsearch plugin is accessible
      - a request to es is blocked
      - es does not respond, or responds with a status >= 500
    - on each event:
      - set `isEsUsable` to `undefined`
      - attempt to put the index template to elasticsearch
      - set `isEsUsable` to wether putTemplate was successful
@spalger spalger added the WIP Work in progress label Sep 23, 2017
@spalger spalger changed the title [SavedObjects] use index template rather than healthcheck [savedObjects] use index template rather than healthcheck Sep 23, 2017
@epixa epixa mentioned this pull request Sep 23, 2017
@spalger
Copy link
Contributor Author

spalger commented Sep 28, 2017

I'm putting this on ice, using #14202 solves my immediate need

@spalger spalger closed this Sep 28, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
blocked WIP Work in progress
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant