Skip to content

Commit

Permalink
Update health-check-api.md
Browse files Browse the repository at this point in the history
  • Loading branch information
blinkov authored Sep 4, 2024
1 parent 9168b0f commit bac6a5d
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions ydb/docs/en/core/reference/ydb-sdk/health-check-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ To initiate the check, call the `SelfCheck` method from `NYdb::NMonitoring` name

## Call parameters {#call-parameters}

`SelfCheck` method provides information in the form of a [set of issues](#emergency-example) which could look like this:
`SelfCheck` method provides information in the form of a [set of issues](#example-emergency) which could look like this:

```json
{
Expand Down Expand Up @@ -102,7 +102,7 @@ message IssueLog {
```


#### Description of fields in the response {#fields-description}
### Description of fields in the response {#fields-description}

| Field | Description |
|:----|:----|
Expand All @@ -117,7 +117,7 @@ message IssueLog {
| `database_status` | If the settings include `ReturnVerboseStatus` parameter, the `database_status` field will be populated. <br/>This field offers a comprehensive summary of the overall health of the database. <br/>It is designed to provide a quick overview of the database's condition, helping to assess its health and identify any major issuehs at a high level. [Example](#example-verbose). For the full response structure, see the [ydb_monitoring.proto](https://github.com/ydb-platform/ydb/public/api/protos/ydb_monitoring.proto) file in the {{ ydb-short-name }} Git repository. |
| `location` | Contains information about the host, where the `HealthCheck` service was called |

#### Issues hierarchy {#issues-hierarchy}
### Issues hierarchy {#issues-hierarchy}

Issues can be arranged hierarchically using the `id` and `reason` fields, which help visualize how issues in different modules affect the overall system state. All issues are arranged in a hierarchy where higher levels can depend on nested levels:

Expand Down Expand Up @@ -394,7 +394,7 @@ The shortest `HealthCheck` response looks like this. It is returned if there is
}
```

#### Verbose example {#example-verbose}
### Verbose example {#example-verbose}

`GOOD` response with `verbose` parameter:

Expand Down Expand Up @@ -644,7 +644,7 @@ The shortest `HealthCheck` response looks like this. It is returned if there is
}
```

#### Emergency example {#example-emergency}
### Emergency example {#example-emergency}

Response with `EMERGENCY` status:

Expand Down Expand Up @@ -843,4 +843,4 @@ Response with `EMERGENCY` status:
"port": 19001
}
}
```
```

0 comments on commit bac6a5d

Please sign in to comment.