Jennifer88huang commented on a change in pull request #5164: [doc] Improve Pulsar Deployment monitoring URL: https://github.com/apache/pulsar/pull/5164#discussion_r322566381
########## File path: site2/docs/deploy-monitoring.md ########## @@ -35,60 +34,52 @@ http://$BROKER_ADDRESS:8080/metrics ### ZooKeeper stats -The local Zookeeper/configuration store server and clients that are shipped with Pulsar have been instrumented to expose -detailed stats through Prometheus as well. +The local Zookeeper and configuration store server and clients that are shipped with Pulsar have been instrumented to expose detailed stats through Prometheus as well. ```shell http://$LOCAL_ZK_SERVER:8000/metrics http://$GLOBAL_ZK_SERVER:8001/metrics ``` -The default port of local ZooKeeper is `8000` and that of configuration store is `8001`. -These can be changed by specifying system property `stats_server_port`. +The default port of local ZooKeeper is `8000` and the default port of configuration store is `8001`. You can change the default port of local Zookeeper and configuration store by specifying system property `stats_server_port`. ### BookKeeper stats For BookKeeper you can configure the stats frameworks by changing the `statsProviderClass` in `conf/bookkeeper.conf`. -By default, the default BookKeeper configuration included with Pulsar distribution will enable -the Prometheus exporter. +By default, the default BookKeeper configuration included with Pulsar distribution enables the Prometheus exporter. ```shell http://$BOOKIE_ADDRESS:8000/metrics ``` -For bookies, the default port is `8000` (instead of `8080`) and that can be configured by changing -the `prometheusStatsHttpPort` in `conf/bookkeeper.conf`. +For bookies, the default port is `8000` (instead of `8080`) and you can configure the default port of bookies by changing the `prometheusStatsHttpPort` in `conf/bookkeeper.conf`. -## Configuring Prometheus +## Configure Prometheus You can configure Prometheus to collect and store the metrics data by following the Prometheus [Getting started](https://prometheus.io/docs/introduction/getting_started/) guide. -When running on bare metal, you can provide the list of nodes that needs to be probed. When deploying -in a Kubernetes cluster, the monitoring is automatically setup with the [provided](deploy-kubernetes.md) -instructions. +When you run on bare metal, you can provide the list of nodes that needs to be probed. When you deploy in a Kubernetes cluster, the monitoring is automatically setup with the [provided](deploy-kubernetes.md) instructions. ## Dashboards -When collecting time series statistics, the major problem is to make sure the number of dimensions -attached to the data does not explode. +When you collect time series statistics, the major problem is to make sure the number of dimensions attached to the data does not explode. -For that reason we only collect time series of metrics aggregated at the namespace level. +For that reason you only need to collect time series of metrics aggregated at the namespace level. ### Pulsar per-topic dashboard The per-topic dashboard instructions are available at [Dashboard](administration-dashboard.md). ### Grafana -You can use grafana to easily create dashboard driven by the data stored in Prometheus. +You can use grafana to easily create dashboard driven by the data that is stored in Prometheus. -There is a `pulsar-grafana` Docker image that is ready to use with the principal dashboards already -in place. This is enabled by default when deploying Pulsar on Kubernetes. +A `pulsar-grafana` Docker image is ready to use with the principal dashboards which is already in place. This is enabled by default when you deploy Pulsar on Kubernetes. Review comment: Refine the first sentence. ---------------------------------------------------------------- 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: [email protected] With regards, Apache Git Services
