From e869d8f7b495e65379212ab8e5ec1f8e8f3fa650 Mon Sep 17 00:00:00 2001 From: "lu.kevin@berkeley.edu" Date: Wed, 28 Nov 2018 12:13:26 +0530 Subject: [PATCH] MINOR: Improve docs by adding ToC links to Monitoring My top 2 reasons for visiting the Kafka docs are to: - View configurations - View metrics This PR aims to improve the user experience for viewing metrics: - Add href links to the `Monitoring` section of the Table of Contents so users do not need to scroll or Ctrl/Cmd-F to find specific metric details (Monitoring section has grown large as more component & metrics are added) Author: lu.kevin@berkeley.edu Reviewers: Viktor Somogyi , Manikumar Reddy Closes #5511 from KevinLiLu/feature/minor-improve-docs --- docs/ops.html | 3 --- docs/toc.html | 9 +++++++++ 2 files changed, 9 insertions(+), 3 deletions(-) diff --git a/docs/ops.html b/docs/ops.html index 3b29dbb3f9b..f48791181c2 100644 --- a/docs/ops.html +++ b/docs/ops.html @@ -1935,9 +1935,6 @@ All the following metrics have a recording level of ``debug``: On the client side, we recommend monitoring the message/byte rate (global and per topic), request rate/size/time, and on the consumer side, max lag in messages among all partitions and min fetch request rate. For a consumer to keep up, max lag needs to be less than a threshold and min fetch rate needs to be larger than 0. -

Audit

- The final alerting we do is on the correctness of the data delivery. We audit that every message that is sent is consumed by all consumers and measure the lag for this to occur. For important topics we alert if a certain completeness is not achieved in a certain time period. The details of this are discussed in KAFKA-260. -

6.7 ZooKeeper

Stable version

diff --git a/docs/toc.html b/docs/toc.html index f1897fe3a0c..a8189216e91 100644 --- a/docs/toc.html +++ b/docs/toc.html @@ -101,6 +101,15 @@
  • Ext4 Notes
  • 6.6 Monitoring +
  • 6.7 ZooKeeper