Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: import dashboard in grafana #3453

Merged
merged 2 commits into from
Dec 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions docs/en_US/operation/usage/monitor_with_prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Binary file added docs/en_US/operation/usage/resources/import-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en_US/operation/usage/resources/import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en_US/operation/usage/resources/paste.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/en_US/operation/usage/resources/pick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
18 changes: 18 additions & 0 deletions docs/zh_CN/operation/usage/monitor_with_prometheus.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
Binary file added docs/zh_CN/operation/usage/resources/import-2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/operation/usage/resources/import.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/operation/usage/resources/paste.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/zh_CN/operation/usage/resources/pick.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading