synchronize cobradocs with vitessio/vitess#14903

vitessio · Feb 16, 2024 · 5de012a · 5de012a
1 parent 90f9f97
commit 5de012a
Show file tree

Hide file tree

Showing 189 changed files with 3,078 additions and 368 deletions.
diff --git a/content/en/docs/16.0/get-started/vttestserver-docker-image.md b/content/en/docs/16.0/get-started/vttestserver-docker-image.md
@@ -89,11 +89,11 @@ docker run --name=vttestserver \
   --health-interval=5s \
   --health-timeout=2s \
   --health-retries=5 \
-  -v vttestserver_data:/vt/vtdataroot \
-  vitess/vttestserver:mysql80 \
+  -v vttestserver_data:/vt/vtdataroot/vitess \
+  vitess/vttestserver:mysql80
   /vt/bin/vttestserver \
   --alsologtostderr \
-  --data_dir=/vt/vtdataroot/ \
+  --data_dir=/vt/vtdataroot/vitess \
   --persistent_mode \
   --port=33574 \
   --mysql_bind_host=0.0.0.0 \

diff --git a/content/en/docs/17.0/get-started/vttestserver-docker-image.md b/content/en/docs/17.0/get-started/vttestserver-docker-image.md
@@ -89,11 +89,11 @@ docker run --name=vttestserver \
   --health-interval=5s \
   --health-timeout=2s \
   --health-retries=5 \
-  -v vttestserver_data:/vt/vtdataroot \
-  vitess/vttestserver:mysql80 \
+  -v vttestserver_data:/vt/vtdataroot/vitess \
+  vitess/vttestserver:mysql80
   /vt/bin/vttestserver \
   --alsologtostderr \
-  --data_dir=/vt/vtdataroot/ \
+  --data_dir=/vt/vtdataroot/vitess \
   --persistent_mode \
   --port=33574 \
   --mysql_bind_host=0.0.0.0 \

diff --git a/content/en/docs/18.0/get-started/vttestserver-docker-image.md b/content/en/docs/18.0/get-started/vttestserver-docker-image.md
@@ -89,11 +89,11 @@ docker run --name=vttestserver \
   --health-interval=5s \
   --health-timeout=2s \
   --health-retries=5 \
-  -v vttestserver_data:/vt/vtdataroot \
-  vitess/vttestserver:mysql80 \
+  -v vttestserver_data:/vt/vtdataroot/vitess \
+  vitess/vttestserver:mysql80
   /vt/bin/vttestserver \
   --alsologtostderr \
-  --data_dir=/vt/vtdataroot/ \
+  --data_dir=/vt/vtdataroot/vitess \
   --persistent_mode \
   --port=33574 \
   --mysql_bind_host=0.0.0.0 \

diff --git a/content/en/docs/19.0/get-started/vttestserver-docker-image.md b/content/en/docs/19.0/get-started/vttestserver-docker-image.md
@@ -98,11 +98,11 @@ docker run --name=vttestserver \
   --health-interval=5s \
   --health-timeout=2s \
   --health-retries=5 \
-  -v vttestserver_data:/vt/vtdataroot \
-  vitess/vttestserver:mysql80 \
+  -v vttestserver_data:/vt/vtdataroot/vitess \
+  vitess/vttestserver:mysql80
   /vt/bin/vttestserver \
   --alsologtostderr \
-  --data_dir=/vt/vtdataroot/ \
+  --data_dir=/vt/vtdataroot/vitess \
   --persistent_mode \
   --port=33574 \
   --mysql_bind_host=0.0.0.0 \

diff --git a/content/en/docs/19.0/reference/features/tablet-throttler.md b/content/en/docs/19.0/reference/features/tablet-throttler.md
@@ -375,76 +375,6 @@ This API call returns the following JSON object:
 The replica tablet only presents `mysql/self` metric (measurement of its own backend MySQL's lag). It does not serve checks for the shard in general.
 
 
-### Metrics
-
-The tablet throttler exports several metrics using the expvars interface. These are available at the `/debug/vars` endpoint of vttablet's http status pages. [More details can be found here](../../features/monitoring/#3-push-based-metrics-system).
-
-#### Aggregated metrics
-
-These are the metrics by which the throttler compares with the threshold and decides whether to accept or reject throttle checks.
-
-##### `ThrottlerAggregatedMysqlSelf`
-
-Gauge, the current metric value of the tablet. This is the result of a self-check, done continuously when the throttler is enabled.
-
-##### `ThrottlerAggregatedMysqlShard`
-
-Gauge, on the `PRIMARY` tablet only, this is the aggregated collected metric value from all serving shard tables, excluding the `PRIMARY`. The `PRIMARY` tablet continuously probes the serving tablets for this metric. As the default collected metric is replication lag, the aggregated value is the highest lag across the probed tablets.
-
-#### Check metrics
-
-The throttler is checked by apps (`vreplication`, `online-ddl`, etc), and responds with status codes, "OK" for "good to proceed" or any other code for "hold off".
-
-At this time the throttler only runs checks with the backend MySQL server. It has the potential to check other input sources.
-
-##### `ThrottlerCheckAnyTotal`
-
-Counter, number of times the throttler has been checked. Tracking this metrics shows the traffic the throttler receives. The value should only increase when an app uses the throttler.
-
-This metric excludes some internal apps (e.g. the schema tracker) that are always on, but does include the throttler's self checks (see following).
-
-##### `ThrottlerCheckAnyError`
-
-Counter. Included in `ThrottlerCheckAnyTotal`, indicating how many times the throttler rejected a check.
-
-##### `ThrottlerCheckAnyMysqlSelfTotal`
-
-Counter. Number of MySQL self-checks this throttler made. Included in `ThrottlerCheckAnyTotal`.
-
-##### `ThrottlerCheckAnyMysqlSelfError`
-
-Counter. Included in `ThrottlerCheckAnyMysqlSelfTotal`, indicating how many times the MySQL self-check resulted in rejection.
-
-##### `ThrottlerCheckAnyMysqlShardTotal`
-
-Counter. Number of MySQL shard-checks this throttler made. Included in `ThrottlerCheckAnyTotal`.
-
-##### `ThrottlerCheckAnyMysqlShardError`
-
-Counter. Included in `ThrottlerCheckAnyMysqlShardTotal`, indicating how many times the MySQL shard-check resulted in rejection.
-
-##### `ThrottlerCheckMysqlSelfSecondsSinceHealthy`
-
-Gauge, number of seconds since the last good MySQL self-check.
-
-##### `ThrottlerCheckMysqlShardSecondsSinceHealthy`
-
-Gauge, number of seconds since the last good MySQL shard-check.
-
-#### Internal throttler metrics
-
-These metrics are helpful when analyzing the throttler behavior, how it interacts with other shard throttlers, its heartbeat mechanism.
-
-##### `ThrottlerProbesTotal`
-
-The throttler probes for metrics independently of checks. Once probed, the result metric is cached, and any further checks are based on that cached value. Further probes overwrite that cached value.
-
-Counter. Total number of probes this throttler made. This includes self probes (e.g. to get the self MySQL metric) and, on `PRIMARY`, the shard probes (e.g. getting MySQL metrics from all serving replicas).
-
-##### `ThrottlerProbesLatency`
-
-Gauge. Time in nanoseconds of last probe. This serves as a general heuristic only for network latency.
-
 ## Resources
 
 - [freno](https://github.com/github/freno) project page

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/_index.md b/content/en/docs/19.0/reference/programs/mysqlctl/_index.md
@@ -1,7 +1,7 @@
 ---
 title: mysqlctl
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init.md
@@ -1,7 +1,7 @@
 ---
 title: init
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl init
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_init_config.md
@@ -1,7 +1,7 @@
 ---
 title: init config
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl init_config
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_position.md
@@ -1,7 +1,7 @@
 ---
 title: position
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl position
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_reinit_config.md
@@ -1,7 +1,7 @@
 ---
 title: reinit config
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl reinit_config
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_shutdown.md
@@ -1,7 +1,7 @@
 ---
 title: shutdown
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl shutdown
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_start.md
@@ -1,7 +1,7 @@
 ---
 title: start
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl start
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md b/content/en/docs/19.0/reference/programs/mysqlctl/mysqlctl_teardown.md
@@ -1,7 +1,7 @@
 ---
 title: teardown
 series: mysqlctl
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctl teardown
 

diff --git a/content/en/docs/19.0/reference/programs/mysqlctld/_index.md b/content/en/docs/19.0/reference/programs/mysqlctld/_index.md
@@ -1,7 +1,7 @@
 ---
 title: mysqlctld
 series: mysqlctld
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## mysqlctld
 

diff --git a/content/en/docs/19.0/reference/programs/topo2topo/_index.md b/content/en/docs/19.0/reference/programs/topo2topo/_index.md
@@ -1,7 +1,7 @@
 ---
 title: topo2topo
 series: topo2topo
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## topo2topo
 

diff --git a/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md b/content/en/docs/19.0/reference/programs/vtaclcheck/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtaclcheck
 series: vtaclcheck
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtaclcheck
 

diff --git a/content/en/docs/19.0/reference/programs/vtbackup/_index.md b/content/en/docs/19.0/reference/programs/vtbackup/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtbackup
 series: vtbackup
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtbackup
 

diff --git a/content/en/docs/19.0/reference/programs/vtclient/_index.md b/content/en/docs/19.0/reference/programs/vtclient/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtclient
 series: vtclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtclient
 

diff --git a/content/en/docs/19.0/reference/programs/vtcombo/_index.md b/content/en/docs/19.0/reference/programs/vtcombo/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtcombo
 series: vtcombo
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtcombo
 

diff --git a/content/en/docs/19.0/reference/programs/vtctld/_index.md b/content/en/docs/19.0/reference/programs/vtctld/_index.md
@@ -1,7 +1,7 @@
 ---
 title: vtctld
 series: vtctld
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctld
 

diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex.md
@@ -1,7 +1,7 @@
 ---
 title: LookupVindex
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient LookupVindex
 

diff --git a/...n/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md b/...n/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_cancel.md
@@ -1,7 +1,7 @@
 ---
 title: LookupVindex cancel
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient LookupVindex cancel
 

diff --git a/...n/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md b/...n/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_create.md
@@ -1,7 +1,7 @@
 ---
 title: LookupVindex create
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient LookupVindex create
 

diff --git a/...s/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md b/...s/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_externalize.md
@@ -1,7 +1,7 @@
 ---
 title: LookupVindex externalize
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient LookupVindex externalize
 

diff --git a/.../en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md b/.../en/docs/19.0/reference/programs/vtctldclient/vtctldclient_LookupVindex_show.md
@@ -1,7 +1,7 @@
 ---
 title: LookupVindex show
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient LookupVindex show
 

diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize.md
@@ -1,7 +1,7 @@
 ---
 title: Materialize
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Materialize
 

diff --git a/...en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md b/...en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_cancel.md
@@ -1,7 +1,7 @@
 ---
 title: Materialize cancel
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Materialize cancel
 

diff --git a/...en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md b/...en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_create.md
@@ -1,7 +1,7 @@
 ---
 title: Materialize create
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Materialize create
 

diff --git a/...t/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md b/...t/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_show.md
@@ -1,7 +1,7 @@
 ---
 title: Materialize show
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Materialize show
 

diff --git a/.../en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md b/.../en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_start.md
@@ -1,7 +1,7 @@
 ---
 title: Materialize start
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Materialize start
 

diff --git a/...t/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md b/...t/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Materialize_stop.md
@@ -1,7 +1,7 @@
 ---
 title: Materialize stop
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Materialize stop
 

diff --git a/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate.md b/content/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate.md
@@ -1,7 +1,7 @@
 ---
 title: Migrate
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Migrate
 

diff --git a/...ent/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md b/...ent/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_cancel.md
@@ -1,7 +1,7 @@
 ---
 title: Migrate cancel
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Migrate cancel
 

diff --git a/...t/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md b/...t/en/docs/19.0/reference/programs/vtctldclient/vtctldclient_Migrate_complete.md
@@ -1,7 +1,7 @@
 ---
 title: Migrate complete
 series: vtctldclient
-commit: f82fb7cbd03db4fb93ba49c49b9ff5e43eb77608
+commit: 2929deecbcdad21ca991cff62db8205e78cc4452
 ---
 ## vtctldclient Migrate complete