Skip to content

Commit

Permalink
Update ydb/docs/en/core/reference/ydb-sdk/health-check-api.md
Browse files Browse the repository at this point in the history
Co-authored-by: Ivan Blinkov <ivan@blinkov.ru>
  • Loading branch information
StekPerepolnen and blinkov authored Jun 19, 2024
1 parent 83c79f9 commit 3791ec5
Showing 1 changed file with 10 additions and 10 deletions.
20 changes: 10 additions & 10 deletions ydb/docs/en/core/reference/ydb-sdk/health-check-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:<ul><li>`GOOD`: No problems were detected.</li><li>`DEGRADED`: Degradation of one of the database systems was detected, but the database is still functioning (for example, allowable disk loss).</li><li>`MAINTENANCE_REQUIRED`: Significant degradation was detected, there is a risk of availability loss, and human maintenance is required.</li><li>`EMERGENCY`: A serious problem was detected in the database, with complete or partial loss of availability.</li></ul> |
| `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. <br/>It can take one of the following values:</li><li>`RED`: A component is faulty or unavailable.</li><li>`ORANGE`: A serious problem, we are one step away from losing availability. Maintenance may be required.</li><li>`YELLOW`: A minor problem, no risks to availability. We recommend you continue monitoring the problem.</li><li>`BLUE`: Temporary minor degradation that does not affect database availability. The system is expected to switch to `GREEN`.</li><li>`GREEN`: No problems were detected.</li><li>`GREY`: Failed to determine the status (a problem with the self-diagnostic mechanism).</li></ul> |
| `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:<ul><li>`GOOD`: No issues were detected.</li><li>`DEGRADED`: Degradation of at least one of the database systems was detected, but the database is still functioning (for example, allowable disk loss).</li><li>`MAINTENANCE_REQUIRED`: Significant degradation was detected, there is a risk of database unavailability, and human intervention is required.</li><li>`EMERGENCY`: A serious problem was detected in the database, with complete or partial unavailability.</li></ul> |
| `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. <br/>It can take one of the following values:<ul><li>`RED`: A component is faulty or unavailable.</li><li>`ORANGE`: A serious problem, a step away from losing availability. Maintenance may be required.</li><li>`YELLOW`: A minor issue, no risks to availability. It is recommended to continue monitoring the issue.</li><li>`BLUE`: Temporary minor degradation that does not affect database availability; the system is expected to switch to `GREEN`.</li><li>`GREEN`: No issues were detected.</li><li>`GREY`: Failed to determine the status (an issue with the self-diagnostic subsystem).</li></ul> |
| `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. <br/>It provides a summary of the overall health of the database. <br/>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}
Expand Down

0 comments on commit 3791ec5

Please sign in to comment.