You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@apisix.apache.org by GitBox <gi...@apache.org> on 2022/06/18 06:56:59 UTC
[GitHub] [apisix] hf400159 opened a new pull request, #7275: docs: udpate prometheus Chinese doc
hf400159 opened a new pull request, #7275:
URL: https://github.com/apache/apisix/pull/7275
### Description
udpate prometheus Chinese docs. https://github.com/apache/apisix/pull/7188.
<!-- Please include a summary of the change and which issue is fixed. -->
<!-- Please also include relevant motivation and context. -->
Fixes # (issue)
### Checklist
- [ ] I have explained the need for this PR and the problem it solves
- [ ] I have explained the changes or the new features added to this PR
- [ ] I have added tests corresponding to this change
- [ ] I have updated the documentation to reflect this change
- [ ] I have verified that this change is backward compatible (If not, please discuss on the [APISIX mailing list](https://github.com/apache/apisix/tree/master#community) first)
<!--
Note
1. Mark the PR as draft until it's ready to be reviewed.
2. Always add/update tests for any changes unless you have a good reason.
3. Always update the documentation to reflect the changes made in the PR.
4. Make a new commit to resolve conversations instead of `push -f`.
5. To resolve merge conflicts, merge master instead of rebasing.
6. Use "request review" to notify the reviewer after making changes.
7. Only a reviewer can mark a conversation as resolved.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] spacewander merged pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
spacewander merged PR #7275:
URL: https://github.com/apache/apisix/pull/7275
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] tzssangglass commented on a diff in pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
tzssangglass commented on code in PR #7275:
URL: https://github.com/apache/apisix/pull/7275#discussion_r901210996
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -1,5 +1,11 @@
---
title: prometheus
+keywords:
+ - APISIX
+ - API Gateway
+ - Plugin
+ - Prometheus
+description: 本文将介绍 API 网关 Apache APISIX 如何通过 prometheus 插件将 metrics 上报到一个开源的监控软件 Prometheus。
Review Comment:
```suggestion
description: 本文将介绍 API 网关 Apache APISIX 如何通过 prometheus 插件将 metrics 上报到开源的监控软件 Prometheus。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a diff in pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7275:
URL: https://github.com/apache/apisix/pull/7275#discussion_r901196044
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -75,70 +102,52 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
"upstream": {
"type": "roundrobin",
"nodes": {
- "127.0.0.1:80": 1
+ "127.0.0.1:1980": 1
}
}
}'
```
-你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
+<!-- 你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
先增加一个 Route：
然后在 route 页面中添加 prometheus 插件：
-
+ -->
-## 如何提取指标数据
+## 提取指标
-我们可以从指定的 url 中提取指标数据 `/apisix/prometheus/metrics`:
+你可以从指定的 URL（默认：`/apisix/prometheus/metrics`）中提取指标数据：
```
curl -i http://127.0.0.1:9091/apisix/prometheus/metrics
```
-把该 uri 地址配置到 prometheus 中去，就会自动完成指标数据提取。
+你可以将该 URI 地址添加到 Prometheus 中来提取指标数据，配置示例如下：
-例子如下：
-
-```yaml
+```yaml title="./prometheus.yml"
scrape_configs:
- job_name: "apisix"
- scrape_interval: 15s # 这个值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
+ scrape_interval: 15s # 该值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
metrics_path: "/apisix/prometheus/metrics"
static_configs:
- targets: ["127.0.0.1:9091"]
```
-我们也可以在 prometheus 控制台中去检查状态：
+现在你可以在 Prometheus 控制台中检查状态：
-## 如何修改暴露指标的 uri
+## 使用 Grafana 绘制指标
-我们可以在 `conf/config.yaml` 的 `plugin_attr` 修改默认的 uri
+`prometheus` 插件导出的指标可以在 Grafana 进行图形化绘制显示。
-| 名称 | 类型 | 默认值 | 描述 |
-| ---------- | ------ | ---------------------------- | -------------- |
-| export_uri | string | "/apisix/prometheus/metrics" | 暴露指标的 uri |
-
-配置示例：
-
-```yaml
-plugin_attr:
- prometheus:
- export_uri: /apisix/metrics
-```
-
-## Grafana 面板
-
-插件导出的指标可以在 Grafana 进行图形化绘制显示。
-
-下载 [Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
+如果需要进行设置，请下载 [APISIX's Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
你可以到 [Grafana 官方](https://grafana.com/grafana/dashboards/11719) 下载 `Grafana` 元数据。
Review Comment:
The official data of Grafana is wrong and needs to be changed. But I don't know how to change it, maybe I should remove this description.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a diff in pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #7275:
URL: https://github.com/apache/apisix/pull/7275#discussion_r901197817
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -75,70 +102,52 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
"upstream": {
"type": "roundrobin",
"nodes": {
- "127.0.0.1:80": 1
+ "127.0.0.1:1980": 1
}
}
}'
```
-你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
+<!-- 你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
先增加一个 Route：
然后在 route 页面中添加 prometheus 插件：
-
+ -->
-## 如何提取指标数据
+## 提取指标
-我们可以从指定的 url 中提取指标数据 `/apisix/prometheus/metrics`:
+你可以从指定的 URL（默认：`/apisix/prometheus/metrics`）中提取指标数据：
```
curl -i http://127.0.0.1:9091/apisix/prometheus/metrics
```
-把该 uri 地址配置到 prometheus 中去，就会自动完成指标数据提取。
+你可以将该 URI 地址添加到 Prometheus 中来提取指标数据，配置示例如下：
-例子如下：
-
-```yaml
+```yaml title="./prometheus.yml"
scrape_configs:
- job_name: "apisix"
- scrape_interval: 15s # 这个值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
+ scrape_interval: 15s # 该值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
metrics_path: "/apisix/prometheus/metrics"
static_configs:
- targets: ["127.0.0.1:9091"]
```
-我们也可以在 prometheus 控制台中去检查状态：
+现在你可以在 Prometheus 控制台中检查状态：
-## 如何修改暴露指标的 uri
+## 使用 Grafana 绘制指标
-我们可以在 `conf/config.yaml` 的 `plugin_attr` 修改默认的 uri
+`prometheus` 插件导出的指标可以在 Grafana 进行图形化绘制显示。
-| 名称 | 类型 | 默认值 | 描述 |
-| ---------- | ------ | ---------------------------- | -------------- |
-| export_uri | string | "/apisix/prometheus/metrics" | 暴露指标的 uri |
-
-配置示例：
-
-```yaml
-plugin_attr:
- prometheus:
- export_uri: /apisix/metrics
-```
-
-## Grafana 面板
-
-插件导出的指标可以在 Grafana 进行图形化绘制显示。
-
-下载 [Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
+如果需要进行设置，请下载 [APISIX's Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
你可以到 [Grafana 官方](https://grafana.com/grafana/dashboards/11719) 下载 `Grafana` 元数据。
Review Comment:
cc @nic-chen
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] hf400159 commented on a diff in pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
hf400159 commented on code in PR #7275:
URL: https://github.com/apache/apisix/pull/7275#discussion_r901196044
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -75,70 +102,52 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
"upstream": {
"type": "roundrobin",
"nodes": {
- "127.0.0.1:80": 1
+ "127.0.0.1:1980": 1
}
}
}'
```
-你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
+<!-- 你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
先增加一个 Route：
然后在 route 页面中添加 prometheus 插件：
-
+ -->
-## 如何提取指标数据
+## 提取指标
-我们可以从指定的 url 中提取指标数据 `/apisix/prometheus/metrics`:
+你可以从指定的 URL（默认：`/apisix/prometheus/metrics`）中提取指标数据：
```
curl -i http://127.0.0.1:9091/apisix/prometheus/metrics
```
-把该 uri 地址配置到 prometheus 中去，就会自动完成指标数据提取。
+你可以将该 URI 地址添加到 Prometheus 中来提取指标数据，配置示例如下：
-例子如下：
-
-```yaml
+```yaml title="./prometheus.yml"
scrape_configs:
- job_name: "apisix"
- scrape_interval: 15s # 这个值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
+ scrape_interval: 15s # 该值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
metrics_path: "/apisix/prometheus/metrics"
static_configs:
- targets: ["127.0.0.1:9091"]
```
-我们也可以在 prometheus 控制台中去检查状态：
+现在你可以在 Prometheus 控制台中检查状态：
-## 如何修改暴露指标的 uri
+## 使用 Grafana 绘制指标
-我们可以在 `conf/config.yaml` 的 `plugin_attr` 修改默认的 uri
+`prometheus` 插件导出的指标可以在 Grafana 进行图形化绘制显示。
-| 名称 | 类型 | 默认值 | 描述 |
-| ---------- | ------ | ---------------------------- | -------------- |
-| export_uri | string | "/apisix/prometheus/metrics" | 暴露指标的 uri |
-
-配置示例：
-
-```yaml
-plugin_attr:
- prometheus:
- export_uri: /apisix/metrics
-```
-
-## Grafana 面板
-
-插件导出的指标可以在 Grafana 进行图形化绘制显示。
-
-下载 [Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
+如果需要进行设置，请下载 [APISIX's Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
你可以到 [Grafana 官方](https://grafana.com/grafana/dashboards/11719) 下载 `Grafana` 元数据。
Review Comment:
The official data of Grafana is wrong and needs to be changed.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on PR #7275:
URL: https://github.com/apache/apisix/pull/7275#issuecomment-1159885011
Thanks for your translation!!
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] nic-chen commented on a diff in pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
nic-chen commented on code in PR #7275:
URL: https://github.com/apache/apisix/pull/7275#discussion_r901241347
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -75,70 +102,52 @@ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f13
"upstream": {
"type": "roundrobin",
"nodes": {
- "127.0.0.1:80": 1
+ "127.0.0.1:1980": 1
}
}
}'
```
-你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
+<!-- 你可以使用 [APISIX Dashboard](https://github.com/apache/apisix-dashboard) 通过 web 界面来完成上面的操作。
先增加一个 Route：
然后在 route 页面中添加 prometheus 插件：
-
+ -->
-## 如何提取指标数据
+## 提取指标
-我们可以从指定的 url 中提取指标数据 `/apisix/prometheus/metrics`:
+你可以从指定的 URL（默认：`/apisix/prometheus/metrics`）中提取指标数据：
```
curl -i http://127.0.0.1:9091/apisix/prometheus/metrics
```
-把该 uri 地址配置到 prometheus 中去，就会自动完成指标数据提取。
+你可以将该 URI 地址添加到 Prometheus 中来提取指标数据，配置示例如下：
-例子如下：
-
-```yaml
+```yaml title="./prometheus.yml"
scrape_configs:
- job_name: "apisix"
- scrape_interval: 15s # 这个值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
+ scrape_interval: 15s # 该值会跟 Prometheus QL 中 rate 函数的时间范围有关系，rate 函数中的时间范围应该至少两倍于该值。
metrics_path: "/apisix/prometheus/metrics"
static_configs:
- targets: ["127.0.0.1:9091"]
```
-我们也可以在 prometheus 控制台中去检查状态：
+现在你可以在 Prometheus 控制台中检查状态：
-## 如何修改暴露指标的 uri
+## 使用 Grafana 绘制指标
-我们可以在 `conf/config.yaml` 的 `plugin_attr` 修改默认的 uri
+`prometheus` 插件导出的指标可以在 Grafana 进行图形化绘制显示。
-| 名称 | 类型 | 默认值 | 描述 |
-| ---------- | ------ | ---------------------------- | -------------- |
-| export_uri | string | "/apisix/prometheus/metrics" | 暴露指标的 uri |
-
-配置示例：
-
-```yaml
-plugin_attr:
- prometheus:
- export_uri: /apisix/metrics
-```
-
-## Grafana 面板
-
-插件导出的指标可以在 Grafana 进行图形化绘制显示。
-
-下载 [Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
+如果需要进行设置，请下载 [APISIX's Grafana dashboard 元数据](https://github.com/apache/apisix/blob/master/docs/assets/other/json/apisix-grafana-dashboard.json) 并导入到 Grafana 中。
你可以到 [Grafana 官方](https://grafana.com/grafana/dashboards/11719) 下载 `Grafana` 元数据。
Review Comment:
I don't have this account. Please help to update when you have time. @membphis
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
[GitHub] [apisix] juzhiyuan commented on a diff in pull request #7275: docs: udpate prometheus Chinese doc
Posted by GitBox <gi...@apache.org>.
juzhiyuan commented on code in PR #7275:
URL: https://github.com/apache/apisix/pull/7275#discussion_r901199518
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -23,50 +29,71 @@ title: prometheus
## 描述
-此插件是提供符合 prometheus 数据格式的监控指标数据。
+`prometheus` 插件以 [Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/#exposition-formats) 规定的格式上报指标到 Prometheus 中。
## 属性
-| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
-| ------------ | ------ | ------ | ------ | ------------ | ----------------------------------------------------- |
-| prefer_name | boolean | 可选 | false | | 设置为`true`时，Prometheus 指标中将使用路由和服务的 `name` 而不是 `id`。 |
+| 名称 | 类型 | 必选项 | 默认值 | 描述 |
+| ------------ | --------| ------ | ------ | ----------------------------------------------------- |
+| prefer_name | boolean | 是 | false | 当设置为 `true` 时，将使用路由或服务的 `name` 标识请求所命中的路由或服务，否则使用其 `id`。 |
-## 接口
+:::note
-插件会增加 `/apisix/prometheus/metrics` 这个接口。
+多个路由或服务可以设置为相同的名称，所以当设置 `prefer_name` 为 `true` 时，请规范命名路由和服务，否则容易引起误解。
Review Comment:
```suggestion
多个路由或服务可以设置为相同的名称，所以当设置 `prefer_name` 为 `true` 时，请规范路由和服务的命名，否则容易引起误解。
```
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -23,50 +29,71 @@ title: prometheus
## 描述
-此插件是提供符合 prometheus 数据格式的监控指标数据。
+`prometheus` 插件以 [Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/#exposition-formats) 规定的格式上报指标到 Prometheus 中。
## 属性
-| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
-| ------------ | ------ | ------ | ------ | ------------ | ----------------------------------------------------- |
-| prefer_name | boolean | 可选 | false | | 设置为`true`时，Prometheus 指标中将使用路由和服务的 `name` 而不是 `id`。 |
+| 名称 | 类型 | 必选项 | 默认值 | 描述 |
+| ------------ | --------| ------ | ------ | ----------------------------------------------------- |
+| prefer_name | boolean | 是 | false | 当设置为 `true` 时，将使用路由或服务的 `name` 标识请求所命中的路由或服务，否则使用其 `id`。 |
Review Comment:
Hi @hf400159, could you please check if `prefer_name` is required?
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -152,46 +161,51 @@ plugin_attr:
## 可用的 HTTP 指标
-* `Status codes`: upstream 服务返回的 HTTP 状态码，可以统计到每个服务或所有服务的响应状态码的次数总和。具有的维度：
+`prometheus` 插件可以导出以下指标：
+
+- Status codes: 上游服务返回的 HTTP 状态码，可以统计到每个服务或所有服务的响应状态码的次数总和。属性如下所示：
- | 名称 | 描述 |
- | -------------| --------------------|
- | code | upstream 服务返回的 HTTP 状态码。 |
- | route | 请求匹配的 route 的 `route_id`，未匹配，则默认为空字符串。 |
- | matched_uri | 请求匹配的 route 的 `uri`，未匹配，则默认为空字符串。 |
- | matched_host | 请求匹配的 route 的 `host`，未匹配，则默认为空字符串。 |
- | service | 与请求匹配的 route 的 `service_id`。当路由缺少 service_id 时，则默认为 `$host`。 |
- | consumer | 与请求匹配的 consumer 的 `consumer_name`。未匹配，则默认为空字符串。 |
- | node | 命中的 upstream 节点 `ip`。|
+ | 名称 | 描述 |
+ | -------------| ----------------------------------------------------------------------------- |
+ | code | 上游服务返回的 HTTP 状态码。 |
+ | route | 与请求匹配的路由 的 `route_id`，如果未匹配，则默认为空字符串。 |
Review Comment:
```suggestion
| route | 与请求匹配的路由的 `route_id`，如果未匹配，则默认为空字符串。 |
```
##########
docs/zh/latest/plugins/prometheus.md:
##########
@@ -23,50 +29,71 @@ title: prometheus
## 描述
-此插件是提供符合 prometheus 数据格式的监控指标数据。
+`prometheus` 插件以 [Prometheus](https://prometheus.io/docs/instrumenting/exposition_formats/#exposition-formats) 规定的格式上报指标到 Prometheus 中。
Review Comment:
```suggestion
该插件以 [Prometheus 文档](https://prometheus.io/docs/instrumenting/exposition_formats/#exposition-formats) 规定的格式上报指标到 Prometheus 中。
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscribe@apisix.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org