Skip to content

Add the reparent metrics to the docs #1606

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
Sep 28, 2023
Merged

Add the reparent metrics to the docs #1606

Show file tree
Hide file tree
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
17 changes: 10 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 @@ -28,13 +28,16 @@ VTOrc supports the following APIs which can be used for monitoring and changing

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. |
| `ErrantGtidTabletCount` | The number of tablets with errant GTIDs as 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. |
| `planned_reparent_counts` | Number of times Planned Reparent Shard has been run. It is further subdivided by the keyspace, shard and the result of the operation. |
| `emergency_reparent_counts` | Number of times Emergency Reparent Shard has been run. It is further subdivided by the keyspace, shard and the result of the operation. |
| `reparent_shard_operation_timings` | Timings of reparent shard operations indexed by the type of operation. |


{{< info >}}
Expand Down
10 changes: 10 additions & 0 deletions content/en/docs/18.0/user-guides/configuration-advanced/reparenting.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,16 @@ This command performs the following actions:

The new primary (if unspecified) is chosen using the configured [Durability Policy](../../configuration-basic/durability_policy).

### Metrics

Metrics are available to be seen on the `/debug/vars` page of VTOrc and vtctld for the reparent operations that they execute:

| Metric | Usage |
|------------------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
| `planned_reparent_counts` | Number of times Planned Reparent Shard has been run. It is further subdivided by the keyspace, shard and the result of the operation. |
| `emergency_reparent_counts` | Number of times Emergency Reparent Shard has been run. It is further subdivided by the keyspace, shard and the result of the operation. |
| `reparent_shard_operation_timings` | Timings of reparent shard operations indexed by the type of operation. |

## External Reparenting

External reparenting occurs when another tool handles the process of changing a shard's primary tablet. After that occurs, the tool needs to call the [`vtctl TabletExternallyReparented`](../../../reference/programs/vtctl/shards/#tabletexternallyreparented) command to ensure that the topology service, replication graph, and serving graph are updated accordingly.
Expand Down