pulsar-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From GitBox <...@apache.org>
Subject [GitHub] [pulsar] Anonymitaet commented on a change in pull request #4910: [doc] Add a documentation page for metrics reference
Date Thu, 08 Aug 2019 11:24:14 GMT
Anonymitaet commented on a change in pull request #4910: [doc] Add a documentation page for
metrics reference
URL: https://github.com/apache/pulsar/pull/4910#discussion_r311956621
 
 

 ##########
 File path: site2/docs/reference-metrics.md
 ##########
 @@ -0,0 +1,234 @@
+---
+id: reference-metrics
+title: Pulsar Metrics
+sidebar_label: Pulsar Metrics
+---
+
+<style type="text/css">
+  table{
+    font-size: 80%;
+  }
+</style>
+
+Pulsar exposes metrics in Prometheus format that can be collected and used for monitoring
the health of the cluster.
+
+* [ZooKeeper](#zookeeper)
+* [BookKeeper](#bookkeeper)
+* [Broker](#broker)
+
+## Overview
+
+The metrics exposed by Pulsar are in Prometheus format. The types of metrics are:
+
+- [Counter](https://prometheus.io/docs/concepts/metric_types/#counter): a cumulative metric
that represents a single monotonically increasing counter whose value can only increase or
be reset to zero on restart.
+- [Gauge](https://prometheus.io/docs/concepts/metric_types/#gauge): A *gauge* is a metric
that represents a single numerical value that can arbitrarily go up and down.
+- [Histogram](https://prometheus.io/docs/concepts/metric_types/#histogram): A histogram samples
observations (usually things like request durations or response sizes) and counts them in
configurable buckets.
+- [Summary](https://prometheus.io/docs/concepts/metric_types/#summary): Similar to a histogram,
a summary samples observations (usually things like request durations and response sizes).
While it also provides a total count of observations and a sum of all observed values, it
calculates configurable quantiles over a sliding time window.
+
+## ZooKeeper
+
+The zookeeper metrics are exposed under "/metrics" at port 8000. You can change the port
by configuring a system
+property `stats_server_port` to use a different port.
+
+### Server Metrics
+
+| Name | Type | Description |
+|---|---|---|
+| zookeeper_server_znode_count | Gauge | Number of z-nodes stored |
+| zookeeper_server_data_size_bytes | Gauge | The total size of all of z-nodes stored |
+| zookeeper_server_connections | Gauge | Number of currently opened connections |
+| zookeeper_server_watches_count | Gauge | Number of watchers registered |
+| zookeeper_server_ephemerals_count | Gauge | Number of ephemeral z-nodes |
+
+### Request Metrics
+
+| Name | Type | Description |
+|---|---|---|
+| zookeeper_server_requests | Counter | The total number of requests received by a particular
server |
+| zookeeper_server_requests_latency_ms | Summary | The requests latency calculated in milliseconds.
<br> Available labels: *type* (write, read). <br> <ul><li>*write*:
the requests that write data to zookeeper</li><li>*read*: the requests that read
data from zookeeper</li></ul>|
+
+## BookKeeper
+
+The bookkeeper metrics are exposed under "/metrics" at port 8000. You can change the port
by updating `prometheusStatsHttpPort`
+in `bookkeeper.conf` configuration file.
+
+### Server Metrics
+
+| Name | Type | Description |
+|---|---|---|
+| bookie_SERVER_STATUS | Gauge | The server status for bookie server. <br><ul><li>1:
the bookie is running in writable mode.</li><li>0: the bookie is running in readonly
mode.</li></ul> |
+| bookkeeper_server_ADD_ENTRY_count | Counter | The total number of ADD_ENTRY requests received
at the bookie. Label `success` used to distinguish successes and failures |
 
 Review comment:
    A period should be placed behind the last word of the sentence. Please check all cases.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

Mime
View raw message