diff --git a/docs/en_US/operation/usage/monitor_with_prometheus.md b/docs/en_US/operation/usage/monitor_with_prometheus.md index 6cf5fce4e6..ab3715931f 100644 --- a/docs/en_US/operation/usage/monitor_with_prometheus.md +++ b/docs/en_US/operation/usage/monitor_with_prometheus.md @@ -159,6 +159,24 @@ eKuiper is predefined in the Grafana panel to help users more clearly and intuit https://github.com/lf-edge/ekuiper/blob/master/metrics/metrics.json ``` +Install eKuiper Dashboard + +Before introducing the eKuiper monitoring panel to grafana, you need to ensure that grafana has configured prometheus as a data source, and that prometheus has collected eKuiper monitoring data. + +![New dashboard in grafana](./resources/import.png) + +Copy metrics json into the text box and click Load. + +![Load metrics in grafana](./resources/paste.png) + +Set the Dashboard name and set the corresponding prometheus data source. + +![Import Dashboard in grafana](./resources/import-2.png) + +After we introduce the panel, we can view the corresponding eKuiper instance and the metrics associated with the corresponding rules in the instance in the selection bar on the page. + +![Pick metrics in grafana](./resources/pick.png) + You can view the historical status of the rule through the following panel. 1 means the rule is running, 0 means the rule is suspended normally, and -1 means the rule exited abnormally. The metric is `kuiper_rule_status`. ![rule status](./resources/ruleStatus.png) diff --git a/docs/en_US/operation/usage/resources/import-2.png b/docs/en_US/operation/usage/resources/import-2.png new file mode 100644 index 0000000000..a1479dd8ca Binary files /dev/null and b/docs/en_US/operation/usage/resources/import-2.png differ diff --git a/docs/en_US/operation/usage/resources/import.png b/docs/en_US/operation/usage/resources/import.png new file mode 100644 index 0000000000..129447cc06 Binary files /dev/null and b/docs/en_US/operation/usage/resources/import.png differ diff --git a/docs/en_US/operation/usage/resources/paste.png b/docs/en_US/operation/usage/resources/paste.png new file mode 100644 index 0000000000..0063c41a96 Binary files /dev/null and b/docs/en_US/operation/usage/resources/paste.png differ diff --git a/docs/en_US/operation/usage/resources/pick.png b/docs/en_US/operation/usage/resources/pick.png new file mode 100644 index 0000000000..e2312a0ea1 Binary files /dev/null and b/docs/en_US/operation/usage/resources/pick.png differ diff --git a/docs/zh_CN/operation/usage/monitor_with_prometheus.md b/docs/zh_CN/operation/usage/monitor_with_prometheus.md index 1d44e05b96..4e5c67029c 100644 --- a/docs/zh_CN/operation/usage/monitor_with_prometheus.md +++ b/docs/zh_CN/operation/usage/monitor_with_prometheus.md @@ -159,6 +159,24 @@ eKuiper 预定义了在 Grafana 面板用于帮助用户更加清晰直观的从 https://github.com/lf-edge/ekuiper/blob/master/metrics/metrics.json ``` +安装 eKuiper 面板 + +在将 eKuiper 监控面板引入到 grafana 前,需要确保该 grafana 已经配置了 prometheus 作为数据源,并且该 prometheus 已经采集了 eKuiper 的监控数据。 + +![New dashboard in grafana](./resources/import.png) + +将 metrics json 复制到文本框中,点击 Load + +![Load metrics in grafana](./resources/paste.png) + +设置好 Dashboard 名称并且设置对应的 prometheus 数据源 + +![Import Dashboard in grafana](./resources/import-2.png) + +当我们将面板引入后,我们可以通过在页面上的选择栏中,查看对应的 eKuiper 实例和该实例内对应的规则所关联的 metrics + +![Pick metrics in grafana](./resources/pick.png) + 你可以通过以下面板查看规则的历史状态,1 代表规则正在运行,0 代表规则正常暂停,-1 代表规则异常退出,指标名为 `kuiper_rule_status`。 ![rule status](./resources/ruleStatus.png) diff --git a/docs/zh_CN/operation/usage/resources/import-2.png b/docs/zh_CN/operation/usage/resources/import-2.png new file mode 100644 index 0000000000..a1479dd8ca Binary files /dev/null and b/docs/zh_CN/operation/usage/resources/import-2.png differ diff --git a/docs/zh_CN/operation/usage/resources/import.png b/docs/zh_CN/operation/usage/resources/import.png new file mode 100644 index 0000000000..129447cc06 Binary files /dev/null and b/docs/zh_CN/operation/usage/resources/import.png differ diff --git a/docs/zh_CN/operation/usage/resources/paste.png b/docs/zh_CN/operation/usage/resources/paste.png new file mode 100644 index 0000000000..0063c41a96 Binary files /dev/null and b/docs/zh_CN/operation/usage/resources/paste.png differ diff --git a/docs/zh_CN/operation/usage/resources/pick.png b/docs/zh_CN/operation/usage/resources/pick.png new file mode 100644 index 0000000000..e2312a0ea1 Binary files /dev/null and b/docs/zh_CN/operation/usage/resources/pick.png differ