Skip to content

Fix docs to reflect change in metrics #1547

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
GuptaManan100 merged 1 commit into from
Aug 2, 2023
Merged

Fix docs to reflect change in metrics #1547

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 8 additions & 7 deletions content/en/docs/18.0/reference/vtorc/ui_api_metrics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,18 +22,19 @@ VTOrc supports the following APIs which can be used for monitoring and changing
| `/debug/health` | This API outputs the health of the VTOrc process. |
| `/debug/liveness` | This API outputs the liveness of the VTOrc process. |
| `/api/replication-analysis` | This API shows the replication analysis of VTOrc. Output is in JSON format. |
| `/api/errant-gtids` | This API shows the tablets that have errant GTIDs as detected by VTOrc. Output is in JSON format. This API supports filtering by keyspace and shard name. |

# Metrics

Metrics are available to be seen on the `/debug/vars` page. VTOrc exports the following metrics:

| Metric | Usage |
|------------------------|------------------------------------------------------------------------------------------------------|
| `PendingRecoveries` | The number of recoveries in progress which haven't completed. |
| `RecoveriesCount` | The number of recoveries run. This is further subdivided for all the different recoveries. |
| `SuccessfulRecoveries` | The number of succesful recoveries run. This is further subdivided for all the different recoveries. |
| `FailedRecoveries` | The number of recoveries that failed. This is further subdivided for all the different recoveries. |
| `ErrantGtidMap` | Metric to track the errant GTIDs detected by VTOrc. |
| Metric | Usage |
|-------------------------|------------------------------------------------------------------------------------------------------|
| `PendingRecoveries` | The number of recoveries in progress which haven't completed. |
| `RecoveriesCount` | The number of recoveries run. This is further subdivided for all the different recoveries. |
| `SuccessfulRecoveries` | The number of succesful recoveries run. This is further subdivided for all the different recoveries. |
| `FailedRecoveries` | The number of recoveries that failed. This is further subdivided for all the different recoveries. |
| `ErrantGtidTabletCount` | The number of tablets with errant GTIDs as detected by VTOrc. |


{{< info >}}
Expand Down