From 3791ec59a37d5a8cb89d9156f01d810ce06a2a37 Mon Sep 17 00:00:00 2001 From: Andrei Rykov Date: Wed, 19 Jun 2024 15:05:17 +0200 Subject: [PATCH] Update ydb/docs/en/core/reference/ydb-sdk/health-check-api.md Co-authored-by: Ivan Blinkov --- .../reference/ydb-sdk/health-check-api.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/ydb/docs/en/core/reference/ydb-sdk/health-check-api.md b/ydb/docs/en/core/reference/ydb-sdk/health-check-api.md index c83d4445402a..b9613d6696a7 100644 --- a/ydb/docs/en/core/reference/ydb-sdk/health-check-api.md +++ b/ydb/docs/en/core/reference/ydb-sdk/health-check-api.md @@ -60,17 +60,17 @@ Each issue has a nesting `level`. The higher the `level`, the deeper the issue i | Field | Description | |:----|:----| -| `self_check_result` | enum field which contains the DB check result: | -| `issue_log` | This is a set of elements, each of which describes a problem in the system at a certain level. | -| `issue_log.id` | A unique problem ID within this response. | -| `issue_log.status` | Status (severity) of the current problem.
It can take one of the following values:
  • `RED`: A component is faulty or unavailable.
  • `ORANGE`: A serious problem, we are one step away from losing availability. Maintenance may be required.
  • `YELLOW`: A minor problem, no risks to availability. We recommend you continue monitoring the problem.
  • `BLUE`: Temporary minor degradation that does not affect database availability. The system is expected to switch to `GREEN`.
  • `GREEN`: No problems were detected.
  • `GREY`: Failed to determine the status (a problem with the self-diagnostic mechanism).
    • | -| `issue_log.message` | Text that describes the problem. | -| `issue_log.location` | Location of the problem. | -| `issue_log.reason` | This is a set of elements, each of which describes a problem in the system at a certain level. | -| `issue_log.type` | Problem category (by subsystem). | -| `issue_log.level` | Depth of the problem nesting. | +| `self_check_result` | enum field which contains the database check result: | +| `issue_log` | This is a set of elements, each of which describes an issue in the system at a certain level. | +| `issue_log.id` | A unique issue ID within this response. | +| `issue_log.status` | Status (severity) of the current issue.
    It can take one of the following values: | +| `issue_log.message` | Text that describes the issue. | +| `issue_log.location` | Location of the issue. | +| `issue_log.reason` | This is a set of elements, each of which describes an issue in the system at a certain level. | +| `issue_log.type` | Issue category (by subsystem). | +| `issue_log.level` | Issue nesting depth. | | `database_status` | If settings contains `verbose` parameter than `database_status` field will be filled.
    It provides a summary of the overall health of the database.
    It's used to quickly review the overall health of the database, helping to assess its health and whether there are any serious problems at a high level. | -| `location` | Contains information about host, where `HealthCheck` service was called | +| `location` | Contains information about the host, where the `HealthCheck` service was called | ## Call parameters {#call-parameters}