diff options
| author |   Filip Krzywka <filip.krzywka@nokia.com> | 2019-03-19 15:53:15 +0100 |
|---|---|---|
| committer | Filip Krzywka <filip.krzywka@nokia.com> | 2019-04-11 11:33:05 +0200 |
| commit | 12acf3e8deaf15c6e5263b2b402c966f495057f1 (patch) | |
| tree | 4afa68c835536413d4d8290856659cebeb0dc1c7 /docs/sections/services/ves-hv/healthcheck-and-monitoring.rst | |
| parent | 580eae246a3ac7bf9533df96d20c0fc9b5425d3c (diff) | |
Update HV-VES documentation
- include changes to collector configuration, especially moving from
command line parameters to configuration file
- include changes to run-time configuration i.e. moving from direct
Consul requests to CBS usage
- changes in design.rst cover extraction of protofiles from hv-ves
repository to sdk
- also swapped rstTable to rstCSVTable in deployment.rst as they
are easier to maintain
Change-Id: I5cdee7170d03edaf31615e40f6cb6ad14a6a2331
Issue-ID: DCAEGEN2-1352
Signed-off-by: Filip Krzywka <filip.krzywka@nokia.com>
Diffstat (limited to 'docs/sections/services/ves-hv/healthcheck-and-monitoring.rst')
| -rw-r--r-- | docs/sections/services/ves-hv/healthcheck-and-monitoring.rst | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst b/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst index 18333778..9d35e1ef 100644 --- a/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst +++ b/docs/sections/services/ves-hv/healthcheck-and-monitoring.rst @@ -9,7 +9,7 @@ Healthcheck and Monitoring Healthcheck ----------- Inside HV-VES docker container runs a small HTTP service for healthcheck. Port for healthchecks can be configured -at deployment using ``--health-check-api-port`` command line option or via `VESHV_HEALTHCHECK_API_PORT` environment variable (for details see :ref:`deployment`). +at deployment using command line (for details see :ref:`deployment`). This service exposes endpoint **GET /health/ready** which returns a **HTTP 200 OK** when HV-VES is healthy and ready for connections. Otherwise it returns a **HTTP 503 Service Unavailable** message with a short reason of unhealthiness. @@ -90,4 +90,4 @@ JVM metrics: Sample response for **GET monitoring/prometheus**: -.. literalinclude:: metrics_sample_response.txt +.. literalinclude:: resources/metrics_sample_response.txt |