rocketmq-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wlliqip...@apache.org
Subject [rocketmq-exporter] 35/43: Polish the doc
Date Sun, 08 Mar 2020 13:16:55 GMT
This is an automated email from the ASF dual-hosted git repository.

wlliqipeng pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/rocketmq-exporter.git

commit 4676344c0ef728e06e8908f8570321dbd21df025
Author: vongosling <vongosling@apache.org>
AuthorDate: Mon Jul 22 20:07:20 2019 +0800

    Polish the doc
---
 README.md                                          | 40 ++++++++++------------
 ...e_example.md => rocketmq_exporter_quickstart.md | 33 ++++--------------
 2 files changed, 24 insertions(+), 49 deletions(-)

diff --git a/README.md b/README.md
index 28d236c..463d366 100644
--- a/README.md
+++ b/README.md
@@ -6,33 +6,40 @@ Apache RocketMQ Exporter for Prometheus.
 Table of Contents
 -----------------
 -	[Compatibility](#compatibility)
--   [Dependency](#dependency)
--   [Download](#download)
--   [Compile](#compile)
+-   [Configuration](#configuration)
+-   [Build](#build)
 	-   [Build Binary](#build-binary)
 	-   [Build Docker Image](#build-docker-image)
 -   [Run](#run)
 	-   [Run Binary](#run-binary)
 	-   [Run Docker Image](#run-docker-image)
--   [Flags](#flags)
 -   [Metrics](#metrics)
 	-   [Brokers](#brokers)
 	-   [Topics](#topics)
 	-   [Consumer Groups](#consumer-groups)
--   [Grafana Dashboard](#Grafana-Dashboard)
--   [Quick Start](#Use-Example)
+-   [Grafana Dashboard](#grafana-dashboard)
+-   [Quick Start](#quick-start)
 
 Compatibility
 -------------
 
 Support [Apache RocketMQ](https://rocketmq.apache.org) version 4.3.2 (and later).
 
-Dependency
-----------
 
--	[Prometheus](https://prometheus.io)
+Configuration
+---
+
+This image is configurable using different properties, See ``application.properties`` for
a configuration example.
+
+| name                           | Default            | Description                     
                  |
+| -----------------------------------|--------------------|----------------------------------------------------|
+| `rocketmq.config.namesrvAddr`      |  127.0.0.1:9876 |name server address  for  broker
cluster            |
+| `rocketmq.config.webTelemetryPath` | /metrics           |Path under which to expose metrics
                 |
+| `server.port`                      | 5557               |Address to listen on for web interface
and telemetry|
+| `rocketmq.config.rocketmqVersion`  | V4_3_2             |rocketmq broker version      
                      |
+
 
-Compile
+Build
 -------
 
 ### Build Binary
@@ -62,17 +69,6 @@ java -jar rocketmq-exporter-0.0.1-SNAPSHOT.jar
 docker container run -itd --rm  -p 5557:5557  docker.io/rocketmq-exporter
 ```
 
-Flags
----
-
-This image is configurable using different flags
-
-|Flag name                           | Default            | Description                 
                      |
-| -----------------------------------|--------------------|----------------------------------------------------|
-| `rocketmq.config.namesrvAddr`      |  127.0.0.1:9876 |name server address  for  broker
cluster            |
-| `rocketmq.config.webTelemetryPath` | /metrics           |Path under which to expose metrics
                 |
-| `server.port`                      | 5557               |Address to listen on for web interface
and telemetry|
-| `rocketmq.config.rocketmqVersion`  | V4_3_2             |rocketmq broker version      
                      |
 
 Metrics
 -------
@@ -212,4 +208,4 @@ For details of the dashboard please see [RocketMQ Exporter Overview](https://gra
 
 Quick Start
 -------------
-For details of the use example please refer to [use example](./rocketmq_exporter_use_example.md)
+This [guide]((./rocketmq_exporter_quickstart.md)) will teach you how to build and run rocketmq
exporter from scratch.
diff --git a/rocketmq_exporter_use_example.md b/rocketmq_exporter_quickstart.md
similarity index 76%
rename from rocketmq_exporter_use_example.md
rename to rocketmq_exporter_quickstart.md
index 27a90d4..4ba2863 100644
--- a/rocketmq_exporter_use_example.md
+++ b/rocketmq_exporter_quickstart.md
@@ -1,33 +1,12 @@
 # RocketMQ Exporter Quick Start #
 
-## 1 Start up NameServer and Broker ##
-In order to use the RocketMQ Exporter, firstly make sure that the RocketMQ service is properly
downloaded and started. Users can refer to the quick start of the RocketMQ master station
for operation. Make sure the NameServer and Broker have started correctly.
+## Start up NameServer and Broker
+To use RocketMQ Exporter, first make sure the RocketMQ is downloaded and started correctly.
Users can refer to [quick start](http://rocketmq.apache.org/docs/quick-start/) ensure that
the service starts properly.
 
-## 2 Compile RocketMQ-Exporter ##
-Users currently need to download the git source code and then compile it
+## Build and Run RocketMQ Exporter
 
-```
-git clone https://github.com/apache/rocketmq-exporter
-cd rocketmq-exporter
-mvn clean install
-```
-
-## 3 Configuration and startup ##
-RocketMQ-Exporter has the following running options
-
-operations | default value | meaning 
----|---|---
-rocketmq.config.namesrvAddr | 127.0.0.1:9876 | MQ cluster nameSrv address 
-rocketmq.config.webTelemetryPath | /metrics | metric collection path 
-server.port | 5557 | HTTP service exposed port 
-
-The above running options can be changed either in the configuration file after downloading
the code or via the command line. The compiled jar package is called rocketmq-exporter-0.0.1-SNAPSHOT.jar,
which can be run as follows.
-
-```
-java -jar rocketmq-exporter-0.0.1-SNAPSHOT.jar [--rocketmq.config.namesrvAddr="127.0.0.1:9876"
...]
-```
 
-## 4 Install Prometheus ##
+## Install Prometheus
 Firstly go to Prometheus official download address: https://prometheus.io/download/ to download
the Prometheus installation package, currently using linux installation as an example, the
selected installation package is Prometheus-2.7.0-rc.1.linux-amd64.tar.gz, the Prometheus
process can be started after the following steps.
 
 ```
@@ -65,7 +44,7 @@ global:
 
 
 
-## 5 Create Grafana dashboard for RocketMQ ##
+## Create Grafana dashboard for RocketMQ
 
 Prometheus' own metric display platform is not as good as Grafana. In order to  better show
RocketMQ's metrics, Grafana can be used to show the metrics that Prometheus gets. Firstly
go to the official website https://grafana.com/grafana/download to download installation file.
Here is a  an example for binary file installation.
 
@@ -82,7 +61,7 @@ Similarly, in order not to conflict with the ports of other processes, users
can
 
 Then, by accessing http:// server ip:55555 through the browser, users can verify whether
the Grafana has been successfully installed. The system default username and password are
admin/admin. The first time users log in to the system, users will be asked to change the
password. In addition, users need to set Grafana's data source to Prometheus. If user have
started up Prometheus like above, now the data source address will be  http:// server ip:5555.
For the convenience of users, RocketM [...]
 
-## 6 Configure alarms in Prometheus
+## Configure alarms in Prometheus
 
 If users want to configure alarms,there are two things users should do. 
 Firstly, modify the Prometheus configuration file prometheus.yml and add the following configuration:



Mime
View raw message