forked from hitachienergy/epiphany
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Health Monitor design doc (hitachienergy#940)
* Fixed line endings for devcontainer * Requirements for Health Monitor app
- Loading branch information
Showing
2 changed files
with
34 additions
and
0 deletions.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,33 @@ | ||
# Epiphany Health Monitor service design proposal | ||
|
||
Affected version: 0.6.x/0.7.x | ||
|
||
## Goals | ||
|
||
Provide service that will be monitoring components (Kubernetes, Docker, Kafka, EFK, Prometheus, etc.) deployed using Epiphany. | ||
|
||
## Use cases | ||
|
||
Service will be installed and used on Virtual Machines/Bare Metal on Ubuntu and RedHat (systemd service). | ||
Health Monitor will check status of components that were installed on the cluster. Combinations of those components can be different and will be provided to the service through configuration file. | ||
|
||
Components that Health Monitor should check: | ||
- Kubernetes (kubelet)* | ||
- Query Kubernetes health endpoint (/healthz)* | ||
- Docker* | ||
- Query Docker stats* | ||
- PostgreSQL | ||
- HAProxy | ||
- Prometheus | ||
- Kafka | ||
- ZooKeeper | ||
- ElasticSearch | ||
- RabbitMQ | ||
|
||
`*` means MVP version. | ||
|
||
Health Monitor exposes endpoint that is compliant with [Prometheus metrics format](https://github.com/prometheus/docs/blob/master/content/docs/instrumenting/exposition_formats.md#text-format-example) and serves data about health checks. This endpoint should listen on the configurable port (default 98XX). | ||
|
||
## Design proposal | ||
|
||
TODO |