update readme (#44)

vesoft-inc · Apr 25, 2022 · 3ec5fdd · 3ec5fdd
1 parent ef1aced
commit 3ec5fdd
Show file tree

Hide file tree

Showing 16 changed files with 40 additions and 44 deletions.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 PROJECT="nebula-exporter"
 
 GO ?= go
-VERSION ?= v0.0.6
+VERSION ?= v3.1.0
 DockerUser=vesoft
 
 ifeq (,$(shell go env GOBIN))

diff --git a/README-CN.md b/README-CN.md
@@ -8,11 +8,13 @@
 
 [Nebula Graph](https://github.com/vesoft-inc/nebula-graph) exporter for Prometheus.
 
-一些收集的 metrics 是：
+目前收集的 metrics 是：
 
-- Graphd 的查询 metrics
-- Metad 的心跳 metrics
-- Storaged 中 edge 和 vertex 的 CRUD 的 metrics
+- Graphd 的 metrics
+- Graphd space 级别的 metrics
+- Metad 的 metrics
+- Storaged 的 metrics
+- Stroaged 内置 rocksdb 的 metrics
 
 ## 构建运行 exporter
 
@@ -69,12 +71,12 @@ scrape_configs:
 ```shell
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 
 # 例如:
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 ```
 
 ## 在裸机上运行

diff --git a/README.md b/README.md
@@ -8,11 +8,13 @@
 
 [Nebula Graph](https://github.com/vesoft-inc/nebula-graph) exporter for Prometheus.
 
-Some of the metrics collections are:
+The metrics currently collected are:
 
-- Graphd's query metrics
-- Metad's heartbeat metrics
-- Storaged's CRUD edge and vertex metrics
+- Graphd's metrics
+- Graphd's space level metrics
+- Metad's metrics
+- Storaged's metrics
+- Storaged's rocksdb metrics
 
 ## Building and running the exporter
 
@@ -69,12 +71,12 @@ And adjust the host name `NEBULA_STATS_EXPORTER_HOSTNAME` accordingly.
 ```shell
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 
 # For example:
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 ```
 
 ## Run on Bare Metal

diff --git a/charts/index.yaml b/charts/index.yaml
@@ -2,10 +2,10 @@ apiVersion: v1
 entries:
   nebula-exporter:
   - apiVersion: v1
-    appVersion: v3.0.0
-    created: "2022-02-14T12:07:04.219772+08:00"
+    appVersion: v3.1.0
+    created: "2022-04-25T10:51:18.754717+08:00"
     description: Nebula Graph stats exporter for prometheus
-    digest: b5026b4e12b325e54bac8c8538bb1d21793df3f4a5d7878b312f5f43c12ec6e3
+    digest: 55ff99bfb4504f857bb076c331ad6340c3e6fdb3dda825e04acaa48ff3e69580
     home: https://nebula-graph.io
     icon: https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png
     keywords:
@@ -28,6 +28,6 @@ entries:
     sources:
     - https://github.com/vesoft-inc/nebula
     urls:
-    - https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-0.0.6.tgz
-    version: 0.0.6
-generated: "2022-02-14T12:07:04.219113+08:00"
+    - https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-3.1.0.tgz
+    version: 3.1.0
+generated: "2022-04-25T10:51:18.754081+08:00"
diff --git a/charts/nebula-exporter-0.0.6.tgz b/charts/nebula-exporter-0.0.6.tgz
diff --git a/charts/nebula-exporter-3.1.0.tgz b/charts/nebula-exporter-3.1.0.tgz
diff --git a/charts/nebula-exporter/Chart.yaml b/charts/nebula-exporter/Chart.yaml
@@ -1,5 +1,5 @@
 apiVersion: v1
-appVersion: v3.0.0
+appVersion: v3.1.0
 description: Nebula Graph stats exporter for prometheus
 home: https://nebula-graph.io
 icon: https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png
@@ -22,4 +22,4 @@ maintainers:
 name: nebula-exporter
 sources:
   - https://github.com/vesoft-inc/nebula
-version: 0.0.6
+version: 3.1.0
diff --git a/charts/nebula-exporter/values.yaml b/charts/nebula-exporter/values.yaml
@@ -17,7 +17,7 @@ startUp:
 
 image:
   repository: vesoft/nebula-stats-exporter
-  tag: v0.0.6
+  tag: v3.1.0
   pullPolicy: IfNotPresent
 
 serviceAccount:

diff --git a/deploy/bare-metal/README-CN.md b/deploy/bare-metal/README-CN.md
@@ -17,13 +17,6 @@ clusters:                                   # 您想要监控的 cluster 列表
         endpointPort: 19559                 # instance 的端口
         componentType: metad                # instance 的组建类型, optional value metad, graphd and storaged.
       - ...
-# 废弃: 使用 clusters 来替换
-nebulaItems:                                # 类似 clusters/instances, 默认的 cluster 名称为 '_nebula'
-  - instanceName: metad0                    # 类似 clusters/instances/name
-    endpointIP: 192.168.10.131              # 类似 clusters/instances/endpointIP
-    endpointPort: 19559                     # 类似 clusters/instances/endpointPort
-    componentType: metad                    # 类似 clusters/instances/componentType
-  - ...
 ```
 
 _详情请见 [config.yaml](config.yaml) 。_

diff --git a/deploy/bare-metal/config.yaml b/deploy/bare-metal/config.yaml
@@ -1,4 +1,3 @@
-version: v0.0.6
 clusters:
   - name: nebula
     instances:

diff --git a/deploy/bare-metal/example-CN.md b/deploy/bare-metal/example-CN.md
@@ -5,12 +5,12 @@
 ```shell
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 
 # 例如:
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 ```
 
 ## 安装 prometheus

diff --git a/deploy/bare-metal/example.md b/deploy/bare-metal/example.md
@@ -5,12 +5,12 @@
 ```shell
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 
 # For example:
 $ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
     -v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
-    vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
+    vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
 ```
 
 ## Install prometheus

diff --git a/deploy/kubernetes/README-CN.md b/deploy/kubernetes/README-CN.md
@@ -20,7 +20,7 @@ _访问 [helm repo](https://helm.sh/docs/helm/helm_repo/) 来查看命令文档
 
 ```shell
 export NEBULA_EXPORTER_NAMESPACE=nebula     # 您想要安装 nebula exporter 的 namespace
-export CHART_VERSION=v0.0.6                 # Nebula Exporter 的 chart 版本
+export CHART_VERSION=v3.1.0                 # Nebula Exporter 的 chart 版本
 
 $ kubectl create namespace "${NEBULA_EXPORTER_NAMESPACE}" # 如果您已经创建了，请跳过
 $ helm install nebula-exporter nebula-exporter/nebula-exporter \
@@ -35,7 +35,7 @@ nebula-exporter-5964b765c9-4xfkm   1/1     Running   0          44s
 
 注意:
 
-* `${chart_version}` 表示 Nebula Exporter chart 的版本。 例如，v0.0.6 。 您可以通过运行 `helm search repo -l nebula-exporter` 命令来查看当前支持的版本。
+* `${chart_version}` 表示 Nebula Exporter chart 的版本。 例如，v3.1.0 。 您可以通过运行 `helm search repo -l nebula-exporter` 命令来查看当前支持的版本。
 
 _访问 [helm install](https://helm.sh/docs/helm/helm_install/) 来查看命令文档。_
 
@@ -85,7 +85,7 @@ $ helm show values nebula-exporter/nebula-exporter
 | `startUp.listenPort` | Nebula metrics 服务监听端口 | `9100` |
 | `startUp.maxRequests` | 最大并行抓取请求数，使用 0 则不限制 | `40` |
 | `image.repository` | Nebula stats exporter image repository | `vesoft/nebula-stats-exporter` |
-| `image.tag` | Nebula stats exporter image tag | `v0.0.6` |
+| `image.tag` | Nebula stats exporter image tag | `v3.1.0` |
 | `image.pullPolicy` | Nebula stats exporter imagePullPolicy | `IfNotPresent` |
 | `serviceAccount.create` | 指定是否应创建 service account | `true` |
 | `serviceAccount.annotations` | 添加到 service account 的 annotations | `{}` |

diff --git a/deploy/kubernetes/README.md b/deploy/kubernetes/README.md
@@ -20,7 +20,7 @@ _See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation
 
 ```shell
 export NEBULA_EXPORTER_NAMESPACE=nebula     # the namespace you want to install the nebula exporter
-export CHART_VERSION=v0.0.6                 # the chart version of Nebula Exporter
+export CHART_VERSION=v3.1.0                 # the chart version of Nebula Exporter
 
 $ kubectl create namespace "${NEBULA_EXPORTER_NAMESPACE}" # If you have already created it, please skip.
 $ helm install nebula-exporter nebula-exporter/nebula-exporter \
@@ -35,7 +35,7 @@ nebula-exporter-5964b765c9-4xfkm   1/1     Running   0          44s
 
 Notes:
 
-* `${chart_version}` represents the chart version of Nebula Exporter. For example, v0.0.6. You can view the currently supported versions by running the `helm search repo -l nebula-exporter` command.
+* `${chart_version}` represents the chart version of Nebula Exporter. For example, v3.1.0. You can view the currently supported versions by running the `helm search repo -l nebula-exporter` command.
 
 _See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
 
@@ -85,7 +85,7 @@ The following table lists is the configurable parameters of the chart and their
 | `startUp.listenPort` | The nebula metrics server listening port | `9100` |
 | `startUp.maxRequests` | Maximum number of parallel scrape requests, use 0 for no limit | `40` |
 | `image.repository` | Nebula stats exporter image repository | `vesoft/nebula-stats-exporter` |
-| `image.tag` | Nebula stats exporter image tag | `v0.0.6` |
+| `image.tag` | Nebula stats exporter image tag | `v3.1.0` |
 | `image.pullPolicy` | Nebula stats exporter imagePullPolicy | `IfNotPresent` |
 | `serviceAccount.create` | Specifies whether a service account should be created | `true` |
 | `serviceAccount.annotations` | Annotations to add to the service account | `{}` |

diff --git a/deploy/kubernetes/example-CN.md b/deploy/kubernetes/example-CN.md
@@ -59,12 +59,12 @@ _详情请见 [Install Nebula Cluster with helm](https://github.com/vesoft-inc/n
 
 ```shell
 $ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
-    --namespace=example1 --version=v0.0.6 \
+    --namespace=example1 --version=v3.1.0 \
     --set serviceMonitor.enabled=true \
     --set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
 
 $ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
-    --namespace=example2 --version=v0.0.6 \
+    --namespace=example2 --version=v3.1.0 \
     --set serviceMonitor.enabled=true \
     --set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
 ```

diff --git a/deploy/kubernetes/example.md b/deploy/kubernetes/example.md
@@ -59,12 +59,12 @@ _See [Install Nebula Cluster with helm](https://github.com/vesoft-inc/nebula-ope
 
 ```shell
 $ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
-    --namespace=example1 --version=v0.0.6 \
+    --namespace=example1 --version=v3.1.0 \
     --set serviceMonitor.enabled=true \
     --set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
 
 $ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
-    --namespace=example2 --version=v0.0.6 \
+    --namespace=example2 --version=v3.1.0 \
     --set serviceMonitor.enabled=true \
     --set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
 ```