更新语音播报插件使用文档

Signed-off-by: jikun.zhang <[email protected]>

Author: jikun.zhang

README.MD

@@ -136,6 +136,7 @@ PrometheusAlert具备如下特性
  - 增加支持将Prometheus告警记录写入到Elasticsearch7.x，可通过Kibana进行界面查看告警记录和配置表格导出。
  - 增加支持将Gitlab webhook event推送到企微和钉钉。
  - 增加告警路由和告警记录功能，可通过页面查看告警历史和操作告警消息路由。
+ - 增加告警语音播报插件。
 
 ---------------------
 
@@ -190,6 +191,7 @@ PrometheusAlert具备如下特性
   * [Bark告警配置](doc/readme/conf-bark.md)
   * [百度Hi(如流)告警配置](doc/readme/conf-ruliu.md)
   * [告警记录-ES接入配置](doc/readme/conf-es.md)
+  * [语音播报](doc/readme/conf-voice.md)
 
 * [【告警系统接入PrometheusAlert配置】](doc/readme/system.md)
   * [Prometheus 接入配置](doc/readme/system-prometheus.md)

doc/readme/base-install.md

@@ -100,3 +100,21 @@ helm upgrade --install monitor prometheusalert -n monitoring
     db_name=prometheusalert
     ```
 - 重启PrometheusAlert，这样即完成配置PrometheusAlert使用mysql数据库作为默认后端存储。
+
+--------------------------------------------------------------------
+
+PrometheusAlert语音播报插件部署
+----
+- PrometheusAlert语音播报插件目前仅支持windows系统部署
+
+插件存放在源码`PrometheusAlertVoice`目录下，可直接运行
+
+默认配置文件`setup.ini`
+
+```
+[SERVER]
+#配置插件监听端口
+PORT=9999
+#设置语音播报语速的快慢，该参数的范围是从-10到10之间
+SPEED=1
+```

doc/readme/conf-voice.md

@@ -0,0 +1,16 @@
+PrometheusAlert全家桶语音播报配置说明
+
+-----------------
+
+语音播报功能需要配合`PrometheusAlert语音播报组件`一起使用，组件可以在github的release版本中下载或直接使用项目源码`PrometheusAlertVoice`文件夹中的可执行文件
+
+![voice](../voice_app.png)
+
+```
+#---------------------↓语音播报-----------------------
+#语音播报需要配合语音播报插件才能使用
+#是否开启语音播报通道,0为关闭,1为开启
+open-voice=1
+VOICE_IP=127.0.0.1
+VOICE_PORT=9999
+```