重构文档

Author: xuchao

README.md

@@ -2,14 +2,14 @@ FlinkStreamSQL
 ============
 [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)
 
-##技术交流
+## 技术交流
 - 招聘**大数据平台开发工程师**，想了解岗位详细信息可以添加本人微信号ysqwhiletrue，注明招聘，如有意者发送简历至[[email protected]](mailto:[email protected])
 - 我们使用[钉钉](https://www.dingtalk.com/)沟通交流，可以搜索群号[**30537511**]或者扫描下面的二维码进入钉钉群
 <div align=center>
      <img src=docs/images/streamsql_dd.jpg width=300 />
 </div>
 
-##介绍
+## 介绍
  * 基于开源的flink，对其实时sql进行扩展   
     * 自定义create table 语法（包括源表,输出表,维表）
     * 自定义create view 语法
@@ -18,9 +18,9 @@ FlinkStreamSQL
     * 支持原生FLinkSQL所有的语法
     * 扩展了输入和输出的性能指标到promethus
 
-##目录
+## 目录
 
-[ 1.1 demo]((docs/demo.md))  
+[ 1.1 demo](docs/demo.md)  
 [ 1.2 快速开始](docs/quickStart.md)  
 [ 1.3 参数配置](docs/config.md)  
 [ 1.4 支持的插件介绍和demo](docs/pluginsInfo.md)     

docs/prometheus.md

@@ -0,0 +1,7 @@
+## 使用 prometheus pushgateway 需要设置的 confProp 参数
+* metrics.reporter.promgateway.class: org.apache.flink.metrics.prometheus.PrometheusPushGatewayReporter  
+* metrics.reporter.promgateway.host: prometheus pushgateway的地址  
+* metrics.reporter.promgateway.port：prometheus pushgateway的端口  
+* metrics.reporter.promgateway.jobName: 实例名称
+* metrics.reporter.promgateway.randomJobNameSuffix: 是否在实例名称后面添加随机字符串(默认:true)
+* metrics.reporter.promgateway.deleteOnShutdown: 是否在停止的时候删除数据(默认false)