[Home] Add custom state checks

[sorenlouv]

Kibana Home contains tutorials that help users setup different parts of the Elastic stack. It would be useful to be able to add dynamic status checks, that give feedback to users on whether they have setup things correctly.

Example When setting up APM the user is instructed to setup apm-server and add agents to their services. When setup correctly these will start sending data to elasticsearch. If the tutorial contained a "Check status" button it would be possible to let the users know whether the agents and apm-server are working as expected.

POC If we could add a statusCheck to the manifest file like:

{
  "statusCheck": {
    "index": "xpack.apm.indexPattern",
    "query": {
      "bool": {
        "filter": {
          "exists": {
            "field": "processor.name"
          }
        }
      }
    }
  }
}

where:

• index is the name of a kibana.yml variable, which will be resolved like config.get(statusCheck.index) and return the index pattern
• query is the es query to be executed against the index above. If it returns any results the status check succeeded.

/cc @alexfrancoeur @makwarth @formgeist @vanjacosic

[alexfrancoeur]

Where did we end up with this? I have a feeling we'll need something similar for beats soon. Would be good to check if data is flowing in before navigation.

[sorenlouv]

@nreese If you have time we could pair on this. I have a use case, you have the know how ;)

[alexfrancoeur]

Nathan is out this week, but let's touch base when he returns. If we can't get it in for 6.3, we should aim for 6.4. I believe beats now have version numbers in their index patterns. If we could build this in a generic fashion I think it'd be a huge improvement to the Add Data experience. We'll be able to validate that data is flowing in before enabling navigation, regardless of tutorial type.

On Thu, Apr 5, 2018, 8:32 AM Søren Louv-Jansen notifications@github.com wrote:

@nreese https://github.com/nreese If you have time we could pair on this. I have a use case, you have the know how ;)

— You are receiving this because you were mentioned.

Reply to this email directly, view it on GitHub https://github.com/elastic/kibana/issues/16611#issuecomment-378919872, or mute the thread https://github.com/notifications/unsubscribe-auth/AYA-f8i-XFGEEIPICU9BMPZSTCa17fSsks5tlg7jgaJpZM4R-uP9 .