search

opensearch-project / observability

Visualize and explore your logs, traces and metrics data in OpenSearch Dashboards
https://opensearch.org/docs/latest/observability-plugin/index/
Apache License 2.0
52 stars 97 forks source link

PoC Health Check endpoints for notebooks #254

Open ps48 opened 3 years ago

ps48 commented 3 years ago

Is your feature request related to a problem? Please describe. This feature comes from OpenSearch Plugins issue: https://github.com/opensearch-project/opensearch-plugins/issues/74 As part helping DevOps engineers track health of individual plugins. We should add three endpoints to notebooks for startup, liveness and readiness.

Describe the solution you'd like Notebooks has two components one for OpenSearch and the other for Dashboards. Therefore, we need to create the endpoints for both. The OpenSearch endpoints should be added here and the Dashboards endpoints should be added here.

ps48 commented 2 years ago

Task Division for the Notebooks PoC,

  1. OpenSearch endpoint → Check kibana index - check health with OpenSearch CAT Index API → Check notebooks index - check health with OpenSearch CAT Index API → SQL/PPL - check availability with OpenSearch CAT API

  2. OpenSearch-Dashboard endpoint → Reporting - check availability with kibana status API