From 73531807f33643f27cce9c8d8caa5f8c6b78fff0 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 3 Mar 2021 17:39:47 +0800 Subject: [PATCH 1/3] query metrics --- .../1.query-performance-metrics.md | 102 ++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 docs-2.0/6.monitor and metrics/1.query-performance-metrics.md diff --git a/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md b/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md new file mode 100644 index 00000000000..41bcfe2042b --- /dev/null +++ b/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md @@ -0,0 +1,102 @@ +# 查询Nebula Graph性能指标 + +Nebula Graph支持多种方式查询服务的性能指标，本文将介绍最基础的方式，通过HTTP端口查询性能指标。 + +## 性能指标说明 + +Nebula Graph的每个性能指标都由三个部分组成，中间用英文句号（.）隔开，例如`num_queries.sum.600`。指标说明如下。 + +|类别|说明| +|:---|:---| +|指标名称|简单描述指标的含义。| +|统计类型|指标统计的方法。当前支持SUM、COUNT、AVG、RATE和P分位数（P75、P95、P99、P99.9）。| +|统计时间|指标统计的时间范围，当前支持5秒、60秒、600秒和3600秒，分别表示最近5秒、最近1分钟、最近10分钟和最近1小时。| + +不同的Nebula Graph服务支持查询的性能指标也不同，详情请参见： + +- Meta服务性能指标（TODO: doc） + +- Graph服务性能指标（TODO: doc） + +- Storage服务性能指标（TODO: doc） + +## 通过HTTP端口查询性能指标 + +### 语法 + +```bash +curl -G "http://:/get_stats?stats= [&returnjson]" +``` + +|选项|说明| +|:---|:---| +|`ip`|服务器的IP地址，可以在安装目录内查看yaml配置文件获取。| +|`port`|服务器的HTTP端口，可以在安装目录内查看yaml配置文件获取。默认情况下，Meta服务端口为19559，Graph服务端口为19669，Storage服务端口为19779。| +|`metric_name_list`|性能指标名称，多个性能指标用英文逗号（,）隔开。| +|`&returnjson`|将结果以JSON格式返回。| + + +>**说明**：如果Nebula Graph服务部署在容器中，需要执行`docker-compose ps`命令查看映射到容器外部的端口，然后通过该端口查询。 + +### 示例 + +- 查询单个性能指标 + + 查询Graph服务中，最近10分钟的请求总数。 + + ```bash + $ curl -G "http://192.168.8.40:19669/get_stats?stats=num_queries.sum.600" + num_queries.sum.600=400 + ``` + +- 查询多个性能指标 + + 查询Meta服务中，最近1分钟的心跳平均延迟和最近10分钟P99心跳（1%最慢的心跳）的平均延迟。 + + ```bash + $ curl -G "http://192.168.8.40:19559/get_stats?stats=heartbeat_latency_us.avg.60,heartbeat_latency_us.p99.600" + heartbeat_latency_us.avg.60=281 + heartbeat_latency_us.p99.600=985 + ``` + +- 查询性能指标并以JSON格式返回 + + 查询Storage服务中，最近10分钟新增的点数量，并以JSON格式返回结果。 + + ```bash + $ curl -G "http://192.168.8.40:19779/get_stats?stats=num_add_vertices.sum.600&returnjson" + [{"value":1,"name":"num_add_vertices.sum.600"}] + ``` + +- 查询服务器的所有性能指标 + + 不指定查询某个性能指标时，会返回所有的性能指标。 + + ```bash + $ curl -G "http://192.168.8.40:19559/get_stats" + heartbeat_latency_us.avg.5=304 + heartbeat_latency_us.avg.60=308 + heartbeat_latency_us.avg.600=299 + heartbeat_latency_us.avg.3600=285 + heartbeat_latency_us.p75.5=652 + heartbeat_latency_us.p75.60=669 + heartbeat_latency_us.p75.600=651 + heartbeat_latency_us.p75.3600=642 + heartbeat_latency_us.p95.5=930 + heartbeat_latency_us.p95.60=963 + heartbeat_latency_us.p95.600=933 + heartbeat_latency_us.p95.3600=929 + heartbeat_latency_us.p99.5=986 + heartbeat_latency_us.p99.60=1409 + heartbeat_latency_us.p99.600=989 + heartbeat_latency_us.p99.3600=986 + num_heartbeats.rate.5=0 + num_heartbeats.rate.60=0 + num_heartbeats.rate.600=0 + num_heartbeats.rate.3600=0 + num_heartbeats.sum.5=2 + num_heartbeats.sum.60=40 + num_heartbeats.sum.600=394 + num_heartbeats.sum.3600=2364 + ``` + From 315c65458593f31a023c08443ed3990c47edde07 Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Wed, 3 Mar 2021 18:15:25 +0800 Subject: [PATCH 2/3] query metrics --- .../1.query-performance-metrics.md | 44 +++++++++---------- 1 file changed, 22 insertions(+), 22 deletions(-) diff --git a/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md b/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md index 41bcfe2042b..38430511ac0 100644 --- a/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md +++ b/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md @@ -1,26 +1,26 @@ -# 查询Nebula Graph性能指标 +# 查询Nebula Graph监控指标 -Nebula Graph支持多种方式查询服务的性能指标，本文将介绍最基础的方式，通过HTTP端口查询性能指标。 +Nebula Graph支持多种方式查询服务的监控指标，本文将介绍最基础的方式，即通过HTTP端口查询。 -## 性能指标说明 +## 监控指标说明 -Nebula Graph的每个性能指标都由三个部分组成，中间用英文句号（.）隔开，例如`num_queries.sum.600`。指标说明如下。 +Nebula Graph的每个监控指标都由三个部分组成，中间用英文句号（.）隔开，例如`num_queries.sum.600`。指标说明如下。 -|类别|说明| -|:---|:---| -|指标名称|简单描述指标的含义。| -|统计类型|指标统计的方法。当前支持SUM、COUNT、AVG、RATE和P分位数（P75、P95、P99、P99.9）。| -|统计时间|指标统计的时间范围，当前支持5秒、60秒、600秒和3600秒，分别表示最近5秒、最近1分钟、最近10分钟和最近1小时。| +|类别|示例|说明| +|:---|:---|:---| +|指标名称|`num_queries`|简单描述指标的含义。| +|统计类型|`sum`|指标统计的方法。当前支持SUM、COUNT、AVG、RATE和P分位数（P75、P95、P99、P99.9）。| +|统计时间|`600`|指标统计的时间范围，当前支持5秒、60秒、600秒和3600秒，分别表示最近5秒、最近1分钟、最近10分钟和最近1小时。| -不同的Nebula Graph服务支持查询的性能指标也不同，详情请参见： +不同的Nebula Graph服务支持查询的监控指标也不同，详情请参见： -- Meta服务性能指标（TODO: doc） +- Meta服务监控指标（TODO: doc） -- Graph服务性能指标（TODO: doc） +- Graph服务监控指标（TODO: doc） -- Storage服务性能指标（TODO: doc） +- Storage服务监控指标（TODO: doc） -## 通过HTTP端口查询性能指标 +## 通过HTTP端口查询监控指标 ### 语法 @@ -30,9 +30,9 @@ curl -G "http://:/get_stats?stats= [&returnjson]" |选项|说明| |:---|:---| -|`ip`|服务器的IP地址，可以在安装目录内查看yaml配置文件获取。| -|`port`|服务器的HTTP端口，可以在安装目录内查看yaml配置文件获取。默认情况下，Meta服务端口为19559，Graph服务端口为19669，Storage服务端口为19779。| -|`metric_name_list`|性能指标名称，多个性能指标用英文逗号（,）隔开。| +|`ip`|服务器的IP地址，可以在安装目录内查看配置文件获取。| +|`port`|服务器的HTTP端口，可以在安装目录内查看配置文件获取。默认情况下，Meta服务端口为19559，Graph服务端口为19669，Storage服务端口为19779。| +|`metric_name_list`|监控指标名称，多个监控指标用英文逗号（,）隔开。| |`&returnjson`|将结果以JSON格式返回。| @@ -40,7 +40,7 @@ curl -G "http://:/get_stats?stats= [&returnjson]" ### 示例 -- 查询单个性能指标 +- 查询单个监控指标 查询Graph服务中，最近10分钟的请求总数。 @@ -49,7 +49,7 @@ curl -G "http://:/get_stats?stats= [&returnjson]" num_queries.sum.600=400 ``` -- 查询多个性能指标 +- 查询多个监控指标 查询Meta服务中，最近1分钟的心跳平均延迟和最近10分钟P99心跳（1%最慢的心跳）的平均延迟。 @@ -59,7 +59,7 @@ curl -G "http://:/get_stats?stats= [&returnjson]" heartbeat_latency_us.p99.600=985 ``` -- 查询性能指标并以JSON格式返回 +- 查询监控指标并以JSON格式返回 查询Storage服务中，最近10分钟新增的点数量，并以JSON格式返回结果。 @@ -68,9 +68,9 @@ curl -G "http://:/get_stats?stats= [&returnjson]" [{"value":1,"name":"num_add_vertices.sum.600"}] ``` -- 查询服务器的所有性能指标 +- 查询服务器的所有监控指标 - 不指定查询某个性能指标时，会返回所有的性能指标。 + 不指定查询某个监控指标时，会返回该服务器上所有的监控指标。 ```bash $ curl -G "http://192.168.8.40:19559/get_stats" From 064e9f4d4fff319a9a45bcea8bce45502029d04d Mon Sep 17 00:00:00 2001 From: cooper-lzy <78672629+cooper-lzy@users.noreply.github.com> Date: Thu, 4 Mar 2021 09:41:49 +0800 Subject: [PATCH 3/3] query metrics --- .../6.monitor and metrics/1.query-performance-metrics.md | 8 +------- 1 file changed, 1 insertion(+), 7 deletions(-) diff --git a/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md b/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md index 38430511ac0..8578bb59ebe 100644 --- a/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md +++ b/docs-2.0/6.monitor and metrics/1.query-performance-metrics.md @@ -12,13 +12,7 @@ Nebula Graph的每个监控指标都由三个部分组成，中间用英文句 |统计类型|`sum`|指标统计的方法。当前支持SUM、COUNT、AVG、RATE和P分位数（P75、P95、P99、P99.9）。| |统计时间|`600`|指标统计的时间范围，当前支持5秒、60秒、600秒和3600秒，分别表示最近5秒、最近1分钟、最近10分钟和最近1小时。| -不同的Nebula Graph服务支持查询的监控指标也不同，详情请参见： - -- Meta服务监控指标（TODO: doc） - -- Graph服务监控指标（TODO: doc） - -- Storage服务监控指标（TODO: doc） +不同的Nebula Graph服务支持查询的监控指标也不同，详情请参见Nebula Graph服务监控指标（TODO: doc）。 ## 通过HTTP端口查询监控指标