This is an automated email from the ASF dual-hosted git repository.
andor pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/zookeeper.git
The following commit(s) were added to refs/heads/master by this push:
new 104e78e ZOOKEEPER-3447: add a doc: zookeeperMonitor.md
104e78e is described below
commit 104e78e008f84ab2d350b68db5a8a46297135faa
Author: maoling <[email protected]>
AuthorDate: Fri Aug 2 14:03:25 2019 +0200
ZOOKEEPER-3447: add a doc: zookeeperMonitor.md
- the ZooKeeper `Grafana dashboard`
[template](https://grafana.com/dashboards/10465) now is available which I had
included 8 screenshots for the preview.
- more details in the
[ZOOKEEPER-3447](https://issues.apache.org/jira/browse/ZOOKEEPER-3447)
Author: maoling <[email protected]>
Reviewers: [email protected], [email protected]
Closes #1008 from maoling/ZOOKEEPER-3447 and squashes the following commits:
51b84b53e [maoling] Don't do a hard code installation instructions for
Prometheus
ea3e2e3a3 [maoling] ZOOKEEPER-3447:add a doc: zookeeperMonitor.md
---
.../src/main/resources/markdown/index.md | 1 +
.../main/resources/markdown/zookeeperMonitor.md | 95 ++++++++++++++++++++++
2 files changed, 96 insertions(+)
diff --git a/zookeeper-docs/src/main/resources/markdown/index.md
b/zookeeper-docs/src/main/resources/markdown/index.md
index 246f374..8b38d3f 100644
--- a/zookeeper-docs/src/main/resources/markdown/index.md
+++ b/zookeeper-docs/src/main/resources/markdown/index.md
@@ -51,6 +51,7 @@ archives.
+ [Dynamic Reconfiguration](zookeeperReconfig.html) - a guide on how to
use dynamic reconfiguration in ZooKeeper
+ [ZooKeeper CLI](zookeeperCLI.html) - a guide on how to use the ZooKeeper
command line interface
+ [ZooKeeper Tools](zookeeperTools.html) - a guide on how to use a series
of tools for ZooKeeper
+ + [ZooKeeper Monitor](zookeeperMonitor.html) - a guide on how to monitor
the ZooKeeper
+ **Contributors**
Documents for Developers Contributing to the ZooKeeper Open Source Project
+ [ZooKeeper Internals](zookeeperInternals.html) - assorted topics on the
inner workings of ZooKeeper
diff --git a/zookeeper-docs/src/main/resources/markdown/zookeeperMonitor.md
b/zookeeper-docs/src/main/resources/markdown/zookeeperMonitor.md
new file mode 100644
index 0000000..bbc8d68
--- /dev/null
+++ b/zookeeper-docs/src/main/resources/markdown/zookeeperMonitor.md
@@ -0,0 +1,95 @@
+<!--
+Copyright 2002-2019 The Apache Software Foundation
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+//-->
+
+# ZooKeeper Monitor Guide
+
+* [New Metrics System](#Metrics-System)
+ * [Metrics](#Metrics)
+ * [Prometheus](#Prometheus)
+ * [Grafana](#Grafana)
+
+* [JMX](#JMX)
+
+* [Four letter words](#four-letter-words)
+
+<a name="Metrics-System"></a>
+
+## New Metrics System
+The feature:`New Metrics System` has been available since 3.6.0 which provides
the abundant metrics
+to help users monitor the ZooKeeper on the topic: znode, network, disk,
quorum, leader election,
+client, security, failures, watch/session, requestProcessor, and so forth.
+
+<a name="Metrics"></a>
+
+### Metrics
+All the metrics are included in the `ServerMetrics.java`.
+
+<a name="Prometheus"></a>
+
+### Prometheus
+- Running a [Prometheus](https://prometheus.io/) monitoring service is the
easiest way to ingest and record ZooKeeper's metrics.
+- Pre-requisites:
+ - enable the `Prometheus MetricsProvider` by setting
`metricsProvider.className=org.apache.zookeeper.metrics.prometheus.PrometheusMetricsProvider`
in the zoo.cfg.
+ - the Port is also configurable by setting `metricsProvider.httpPort`（the
default value:7000）
+- Install Prometheus:
+ Go to the official website download [page](https://prometheus.io/download/),
download the latest release.
+
+- Set Prometheus's scraper to target the ZooKeeper cluster endpoints:
+
+ ```bash
+ cat > /tmp/test-zk.yaml <<EOF
+ global:
+ scrape_interval: 10s
+ scrape_configs:
+ - job_name: test-zk
+ static_configs:
+ - targets:
['192.168.10.32:7000','192.168.10.33:7000','192.168.10.34:7000']
+ EOF
+ cat /tmp/test-zk.yaml
+ ```
+
+- Set up the Prometheus handler:
+
+ ```bash
+ nohup /tmp/prometheus \
+ -config.file /tmp/test-zk.yaml \
+ -web.listen-address ":9090" \
+ -storage.local.path "test-zk.data" >> /tmp/test-zk.log 2>&1 &
+ ```
+
+- Now Prometheus will scrape zk metrics every 10 seconds.
+
+<a name="Grafana"></a>
+
+### Grafana
+- Grafana has built-in Prometheus support; just add a Prometheus data source:
+
+ ```bash
+ Name: test-zk
+ Type: Prometheus
+ Url: http://localhost:9090
+ Access: proxy
+ ```
+- Then download and import the default ZooKeeper dashboard
[template](https://grafana.com/dashboards/10465) and customize.
+- Users can ask for Grafana dashboard account if having any good improvements
by writing a email to **[email protected]**.
+
+<a name="JMX"></a>
+## JMX
+More details can be found in
[here](http://zookeeper.apache.org/doc/current/zookeeperJMX.html)
+
+<a name="four-letter-words"></a>
+## Four letter words
+More details can be found in
[here](http://zookeeper.apache.org/doc/current/zookeeperAdmin.html#sc_zkCommands)
\ No newline at end of file
