From d4df994347a7f22e834a6b52b45d64dc70d7a404 Mon Sep 17 00:00:00 2001 From: hallaroo Date: Mon, 21 Dec 2020 08:31:59 -0700 Subject: [PATCH 1/2] adding weight and readding monitoring doc Signed-off-by: hallaroo --- .../en/docs/reference/features/messaging.md | 1 + .../en/docs/reference/features/monitoring.md | 43 +++++++++++++++++++ .../reference/features/mysql-replication.md | 2 +- .../en/docs/reference/features/recovery.md | 1 + .../reference/features/schema-management.md | 1 + .../features/schema-routing-rules.md | 1 + .../en/docs/reference/features/sharding.md | 2 +- .../reference/features/table-lifecycle.md | 1 + .../reference/features/tablet-throttler.md | 1 + .../reference/features/topology-service.md | 1 + .../features/transport-security-model.md | 1 + .../reference/features/two-phase-commit.md | 1 + .../en/docs/reference/features/vindexes.md | 1 + .../docs/reference/features/vreplication.md | 1 + 14 files changed, 56 insertions(+), 2 deletions(-) create mode 100644 content/en/docs/reference/features/monitoring.md diff --git a/content/en/docs/reference/features/messaging.md b/content/en/docs/reference/features/messaging.md index e7476ce01..2082699de 100644 --- a/content/en/docs/reference/features/messaging.md +++ b/content/en/docs/reference/features/messaging.md @@ -1,5 +1,6 @@ --- title: Messaging +weight: 18 aliases: ['/docs/advanced/messaging/','/docs/reference/messaging/'] --- diff --git a/content/en/docs/reference/features/monitoring.md b/content/en/docs/reference/features/monitoring.md new file mode 100644 index 000000000..e0e580d8d --- /dev/null +++ b/content/en/docs/reference/features/monitoring.md @@ -0,0 +1,43 @@ +--- +title: Monitoring +weight: 8 +--- + +# Current state of monitoring + +There are currently three main ways that a Vitess cluster can be monitored. Depending on your needs, you can use any of the following methods: + +## 1. Vitess status pages + +The status HTML pages of various Vitess components can be accessed by pointing your browser to `http://:/debug/status`. The status pages will often display some basic, but useful, information for monitoring. For example, the status page of a vttablet will show the QPS graph for the past few minutes. + +Viewing a status page can be useful since it works out of the box, but it only provides very basic monitoring capabilities. + +## 2. Pull-based metrics system + +Vitess uses Go’s [expvar package](https://golang.org/pkg/expvar/) to expose various metrics, with the expectation that a user can configure a pull-based metrics system to ingest those metrics. Metrics are published to `http://:/debug/vars` as JSON key-value pairs, which should be easy for any metrics system to parse. + +Scraping Vitess variables is a good way to integrate Vitess into an existing monitoring system, and is useful for building up detailed monitoring dashboards. It is also the officially supported way for monitoring Vitess. + +## 3. Push-based metrics system + +Vitess also includes support for push-based metrics systems via plug-ins. Each Vitess component would need to be run with the `--emit_stats` flag. + +By default, the stats_emit_period is 60s, so each component will push stats to the selected backend every minute. This is configurable via the `--stats_emit_period` flag. + +Vitess has preliminary plug-ins to support OpenTSDB as a push-based metrics backend. + +It should be fairly straightforward to write your own plug-in, if you want to support a different backend. The plug-in package simply needs to implement the `PushBackend` interface of the `stats` package. For an example, you can see the [OpenTSDB plugin](https://github.com/vitessio/vitess/blob/master/go/stats/opentsdb/opentsdb.go). + +Once you’ve written the backend plug-in, you also need to register the plug-in from within all the relevant Vitess binaries. An example of how to do this can be seen in [this pull request](https://github.com/vitessio/vitess/pull/469). + +You can then specify that Vitess should publish stats to the backend that you’re targeting by using the `--stats_backend` flag. + +Connecting Vitess to a push-based metrics system can be useful if you’re already running a push-based system that you would like to integrate into. + +# Monitoring with Kubernetes + +The existing methods for integrating metrics are not supported in a Kubernetes environment by the Vitess team yet, but are on the roadmap for the future. However, it should be possible to get the Prometheus backend working with Kubernetes. + +In the meantime, if you run into issues or have questions, please post on our [forum](https://groups.google.com/forum/#!forum/vitess). + diff --git a/content/en/docs/reference/features/mysql-replication.md b/content/en/docs/reference/features/mysql-replication.md index 740347d2d..3ee42df4c 100644 --- a/content/en/docs/reference/features/mysql-replication.md +++ b/content/en/docs/reference/features/mysql-replication.md @@ -1,6 +1,6 @@ --- title: Replication -weight: 5 +weight: 9 aliases: ['/docs/reference/row-based-replication/','/docs/reference/vitess-replication/','/docs/reference/mysql-replication/'] --- diff --git a/content/en/docs/reference/features/recovery.md b/content/en/docs/reference/features/recovery.md index 9a8c88506..ca411eaa5 100644 --- a/content/en/docs/reference/features/recovery.md +++ b/content/en/docs/reference/features/recovery.md @@ -1,5 +1,6 @@ --- title: Point In Time Recovery +weight: 17 aliases: ['/docs/recovery/pitr','/docs/reference/pitr/'] --- diff --git a/content/en/docs/reference/features/schema-management.md b/content/en/docs/reference/features/schema-management.md index 82a2f1b05..77fd29d44 100644 --- a/content/en/docs/reference/features/schema-management.md +++ b/content/en/docs/reference/features/schema-management.md @@ -1,5 +1,6 @@ --- title: Schema Management +weight: 16 aliases: ['/docs/schema-management/','/docs/user-guides/schema-management/','/docs/reference/schema-management/'] --- diff --git a/content/en/docs/reference/features/schema-routing-rules.md b/content/en/docs/reference/features/schema-routing-rules.md index 706e691f2..49fd5a070 100644 --- a/content/en/docs/reference/features/schema-routing-rules.md +++ b/content/en/docs/reference/features/schema-routing-rules.md @@ -1,5 +1,6 @@ --- title: Schema Routing Rules +weight: 15 aliases: ['/docs/schema-management/routing-rules/','/docs/reference/schema-routing-rules/'] --- diff --git a/content/en/docs/reference/features/sharding.md b/content/en/docs/reference/features/sharding.md index 2d0932f7c..4100c7df7 100644 --- a/content/en/docs/reference/features/sharding.md +++ b/content/en/docs/reference/features/sharding.md @@ -1,7 +1,7 @@ --- title: Sharding description: Shard widely, shard often. -weight: 5 +weight: 1 aliases: ['/docs/sharding/','/user-guide/sharding.html','/docs/reference/sharding/'] --- diff --git a/content/en/docs/reference/features/table-lifecycle.md b/content/en/docs/reference/features/table-lifecycle.md index 729711891..2bf59ffdc 100644 --- a/content/en/docs/reference/features/table-lifecycle.md +++ b/content/en/docs/reference/features/table-lifecycle.md @@ -1,5 +1,6 @@ --- title: Table lifecycle +weight: 22 aliases: ['/docs/user-guides/table-lifecycle/','/docs/reference/table-lifecycle/'] --- diff --git a/content/en/docs/reference/features/tablet-throttler.md b/content/en/docs/reference/features/tablet-throttler.md index 12d805fbf..3e2b4c938 100644 --- a/content/en/docs/reference/features/tablet-throttler.md +++ b/content/en/docs/reference/features/tablet-throttler.md @@ -1,5 +1,6 @@ --- title: Tablet throttler +weight: 21 aliases: ['/docs/user-guides/tablet-throttler/','/docs/reference/tablet-throttler/'] --- diff --git a/content/en/docs/reference/features/topology-service.md b/content/en/docs/reference/features/topology-service.md index b808b2874..04cffd15f 100644 --- a/content/en/docs/reference/features/topology-service.md +++ b/content/en/docs/reference/features/topology-service.md @@ -1,5 +1,6 @@ --- title: Topology Service +weight: 20 aliases: ['/docs/user-guides/topology-service/','/docs/reference/topology-service/'] --- diff --git a/content/en/docs/reference/features/transport-security-model.md b/content/en/docs/reference/features/transport-security-model.md index 87fa3b407..1b8365fd0 100644 --- a/content/en/docs/reference/features/transport-security-model.md +++ b/content/en/docs/reference/features/transport-security-model.md @@ -1,5 +1,6 @@ --- title: Transport Security Model +weight: 12 aliases: ['/docs/user-guides/transport-security-model/','/docs/reference/transport-security-model/'] --- diff --git a/content/en/docs/reference/features/two-phase-commit.md b/content/en/docs/reference/features/two-phase-commit.md index 42bd4ee2b..3b72abdfa 100644 --- a/content/en/docs/reference/features/two-phase-commit.md +++ b/content/en/docs/reference/features/two-phase-commit.md @@ -1,5 +1,6 @@ --- title: Two-Phase Commit +weight: 11 aliases: ['/docs/launching/twopc/','/docs/reference/two-phase-commit/'] --- diff --git a/content/en/docs/reference/features/vindexes.md b/content/en/docs/reference/features/vindexes.md index 583c12589..425473c43 100644 --- a/content/en/docs/reference/features/vindexes.md +++ b/content/en/docs/reference/features/vindexes.md @@ -1,5 +1,6 @@ --- title: Vindexes +weight: 10 aliases: ['/docs/schema-management/consistent-lookup/','/docs/reference/vindexes/'] --- diff --git a/content/en/docs/reference/features/vreplication.md b/content/en/docs/reference/features/vreplication.md index ccc044420..e295109f0 100644 --- a/content/en/docs/reference/features/vreplication.md +++ b/content/en/docs/reference/features/vreplication.md @@ -1,5 +1,6 @@ --- title: VReplication +weight: 2 aliases: ['/docs/advanced/vreplication/','/user-guide/update-stream/','/docs/reference/vreplication/'] --- From c96837be915f326b7ade1524ec2fb2e66fe3ebb7 Mon Sep 17 00:00:00 2001 From: hallaroo Date: Tue, 22 Dec 2020 09:14:19 -0700 Subject: [PATCH 2/2] making requested changes Signed-off-by: hallaroo --- content/en/docs/reference/features/monitoring.md | 3 +-- content/en/docs/reference/features/vschema.md | 1 + 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/reference/features/monitoring.md b/content/en/docs/reference/features/monitoring.md index e0e580d8d..858a8b6a6 100644 --- a/content/en/docs/reference/features/monitoring.md +++ b/content/en/docs/reference/features/monitoring.md @@ -39,5 +39,4 @@ Connecting Vitess to a push-based metrics system can be useful if you’re alrea The existing methods for integrating metrics are not supported in a Kubernetes environment by the Vitess team yet, but are on the roadmap for the future. However, it should be possible to get the Prometheus backend working with Kubernetes. -In the meantime, if you run into issues or have questions, please post on our [forum](https://groups.google.com/forum/#!forum/vitess). - +In the meantime, if you run into issues or have questions, please post on our [Slack](https://vitess.io/slack). diff --git a/content/en/docs/reference/features/vschema.md b/content/en/docs/reference/features/vschema.md index 9f26a8806..8645df00b 100644 --- a/content/en/docs/reference/features/vschema.md +++ b/content/en/docs/reference/features/vschema.md @@ -1,5 +1,6 @@ --- title: VSchema +weight: 9 aliases: ['/docs/schema-management/vschema/','/docs/reference/vschema/'] ---