Skip to content

Commit 3ec5fdd

Browse files
kqzhkqzh
authored
update readme (#44)
1 parent ef1aced commit 3ec5fdd

16 files changed

+40
-44
lines changed

‎Makefile

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
PROJECT="nebula-exporter"
22

33
GO ?= go
4-
VERSION ?= v0.0.6
4+
VERSION ?= v3.1.0
55
DockerUser=vesoft
66

77
ifeq (,$(shell go env GOBIN))

‎README-CN.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88

99
[Nebula Graph](https://github.com/vesoft-inc/nebula-graph) exporter for Prometheus.
1010

11-
一些收集的 metrics 是：
11+
目前收集的 metrics 是：
1212

13-
- Graphd 的查询 metrics
14-
- Metad 的心跳 metrics
15-
- Storaged 中 edge 和 vertex 的 CRUD 的 metrics
13+
- Graphd 的 metrics
14+
- Graphd space 级别的 metrics
15+
- Metad 的 metrics
16+
- Storaged 的 metrics
17+
- Stroaged 内置 rocksdb 的 metrics
1618

1719
## 构建运行 exporter
1820

@@ -69,12 +71,12 @@ scrape_configs:
6971
```shell
7072
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
7173
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
72-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
74+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
7375

7476
# 例如:
7577
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
7678
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
77-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
79+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
7880
```
7981
8082
## 在裸机上运行

‎README.md

+8-6
Original file line numberDiff line numberDiff line change
@@ -8,11 +8,13 @@
88

99
[Nebula Graph](https://github.com/vesoft-inc/nebula-graph) exporter for Prometheus.
1010

11-
Some of the metrics collections are:
11+
The metrics currently collected are:
1212

13-
- Graphd's query metrics
14-
- Metad's heartbeat metrics
15-
- Storaged's CRUD edge and vertex metrics
13+
- Graphd's metrics
14+
- Graphd's space level metrics
15+
- Metad's metrics
16+
- Storaged's metrics
17+
- Storaged's rocksdb metrics
1618

1719
## Building and running the exporter
1820

@@ -69,12 +71,12 @@ And adjust the host name `NEBULA_STATS_EXPORTER_HOSTNAME` accordingly.
6971
```shell
7072
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
7173
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
72-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
74+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
7375

7476
# For example:
7577
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
7678
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
77-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
79+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
7880
```
7981
8082
## Run on Bare Metal

‎charts/index.yaml

+6-6
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ apiVersion: v1
22
entries:
33
nebula-exporter:
44
- apiVersion: v1
5-
appVersion: v3.0.0
6-
created: "2022-02-14T12:07:04.219772+08:00"
5+
appVersion: v3.1.0
6+
created: "2022-04-25T10:51:18.754717+08:00"
77
description: Nebula Graph stats exporter for prometheus
8-
digest: b5026b4e12b325e54bac8c8538bb1d21793df3f4a5d7878b312f5f43c12ec6e3
8+
digest: 55ff99bfb4504f857bb076c331ad6340c3e6fdb3dda825e04acaa48ff3e69580
99
home: https://nebula-graph.io
1010
icon: https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png
1111
keywords:
@@ -28,6 +28,6 @@ entries:
2828
sources:
2929
- https://github.com/vesoft-inc/nebula
3030
urls:
31-
- https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-0.0.6.tgz
32-
version: 0.0.6
33-
generated: "2022-02-14T12:07:04.219113+08:00"
31+
- https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-3.1.0.tgz
32+
version: 3.1.0
33+
generated: "2022-04-25T10:51:18.754081+08:00"

‎charts/nebula-exporter-0.0.6.tgz

-3.95 KB
Binary file not shown.

‎charts/nebula-exporter-3.1.0.tgz

3.94 KB
Binary file not shown.

‎charts/nebula-exporter/Chart.yaml

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
apiVersion: v1
2-
appVersion: v3.0.0
2+
appVersion: v3.1.0
33
description: Nebula Graph stats exporter for prometheus
44
home: https://nebula-graph.io
55
icon: https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png
@@ -22,4 +22,4 @@ maintainers:
2222
name: nebula-exporter
2323
sources:
2424
- https://github.com/vesoft-inc/nebula
25-
version: 0.0.6
25+
version: 3.1.0

‎charts/nebula-exporter/values.yaml

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ startUp:
1717

1818
image:
1919
repository: vesoft/nebula-stats-exporter
20-
tag: v0.0.6
20+
tag: v3.1.0
2121
pullPolicy: IfNotPresent
2222

2323
serviceAccount:

‎deploy/bare-metal/README-CN.md

-7
Original file line numberDiff line numberDiff line change
@@ -17,13 +17,6 @@ clusters: # 您想要监控的 cluster 列表
1717
endpointPort: 19559 # instance 的端口
1818
componentType: metad # instance 的组建类型, optional value metad, graphd and storaged.
1919
- ...
20-
# 废弃: 使用 clusters 来替换
21-
nebulaItems: # 类似 clusters/instances, 默认的 cluster 名称为 '_nebula'
22-
- instanceName: metad0 # 类似 clusters/instances/name
23-
endpointIP: 192.168.10.131 # 类似 clusters/instances/endpointIP
24-
endpointPort: 19559 # 类似 clusters/instances/endpointPort
25-
componentType: metad # 类似 clusters/instances/componentType
26-
- ...
2720
```
2821
2922
_详情请见 [config.yaml](config.yaml) 。_

‎deploy/bare-metal/config.yaml

-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,3 @@
1-
version: v0.0.6
21
clusters:
32
- name: nebula
43
instances:

‎deploy/bare-metal/example-CN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
```shell
66
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
77
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
8-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
8+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
99

1010
# 例如:
1111
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
1212
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
13-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
13+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
1414
```
1515

1616
## 安装 prometheus

‎deploy/bare-metal/example.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
```shell
66
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
77
-v "<<PATH_OF_CONFIG_FILE>>:/config.yaml" \
8-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
8+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
99

1010
# For example:
1111
$ docker run -d --restart=always --name nebula-stats-exporter -p 9100:9100 \
1212
-v "$(pwd)/deploy/bare-metal/config.yaml:/config.yaml" \
13-
vesoft/nebula-stats-exporter:v0.0.6 --bare-metal --bare-metal-config=/config.yaml
13+
vesoft/nebula-stats-exporter:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
1414
```
1515

1616
## Install prometheus

‎deploy/kubernetes/README-CN.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ _访问 [helm repo](https://helm.sh/docs/helm/helm_repo/) 来查看命令文档
2020

2121
```shell
2222
export NEBULA_EXPORTER_NAMESPACE=nebula # 您想要安装 nebula exporter 的 namespace
23-
export CHART_VERSION=v0.0.6 # Nebula Exporter 的 chart 版本
23+
export CHART_VERSION=v3.1.0 # Nebula Exporter 的 chart 版本
2424

2525
$ kubectl create namespace "${NEBULA_EXPORTER_NAMESPACE}" # 如果您已经创建了，请跳过
2626
$ helm install nebula-exporter nebula-exporter/nebula-exporter \
@@ -35,7 +35,7 @@ nebula-exporter-5964b765c9-4xfkm 1/1 Running 0 44s
3535

3636
注意:
3737

38-
* `${chart_version}` 表示 Nebula Exporter chart 的版本。 例如，v0.0.6 。 您可以通过运行 `helm search repo -l nebula-exporter` 命令来查看当前支持的版本。
38+
* `${chart_version}` 表示 Nebula Exporter chart 的版本。 例如，v3.1.0 。 您可以通过运行 `helm search repo -l nebula-exporter` 命令来查看当前支持的版本。
3939

4040
_访问 [helm install](https://helm.sh/docs/helm/helm_install/) 来查看命令文档。_
4141

@@ -85,7 +85,7 @@ $ helm show values nebula-exporter/nebula-exporter
8585
| `startUp.listenPort` | Nebula metrics 服务监听端口 | `9100` |
8686
| `startUp.maxRequests` | 最大并行抓取请求数，使用 0 则不限制 | `40` |
8787
| `image.repository` | Nebula stats exporter image repository | `vesoft/nebula-stats-exporter` |
88-
| `image.tag` | Nebula stats exporter image tag | `v0.0.6` |
88+
| `image.tag` | Nebula stats exporter image tag | `v3.1.0` |
8989
| `image.pullPolicy` | Nebula stats exporter imagePullPolicy | `IfNotPresent` |
9090
| `serviceAccount.create` | 指定是否应创建 service account | `true` |
9191
| `serviceAccount.annotations` | 添加到 service account 的 annotations | `{}` |

‎deploy/kubernetes/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ _See [helm repo](https://helm.sh/docs/helm/helm_repo/) for command documentation
2020

2121
```shell
2222
export NEBULA_EXPORTER_NAMESPACE=nebula # the namespace you want to install the nebula exporter
23-
export CHART_VERSION=v0.0.6 # the chart version of Nebula Exporter
23+
export CHART_VERSION=v3.1.0 # the chart version of Nebula Exporter
2424

2525
$ kubectl create namespace "${NEBULA_EXPORTER_NAMESPACE}" # If you have already created it, please skip.
2626
$ helm install nebula-exporter nebula-exporter/nebula-exporter \
@@ -35,7 +35,7 @@ nebula-exporter-5964b765c9-4xfkm 1/1 Running 0 44s
3535

3636
Notes:
3737

38-
* `${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.
38+
* `${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.
3939

4040
_See [helm install](https://helm.sh/docs/helm/helm_install/) for command documentation._
4141

@@ -85,7 +85,7 @@ The following table lists is the configurable parameters of the chart and their
8585
| `startUp.listenPort` | The nebula metrics server listening port | `9100` |
8686
| `startUp.maxRequests` | Maximum number of parallel scrape requests, use 0 for no limit | `40` |
8787
| `image.repository` | Nebula stats exporter image repository | `vesoft/nebula-stats-exporter` |
88-
| `image.tag` | Nebula stats exporter image tag | `v0.0.6` |
88+
| `image.tag` | Nebula stats exporter image tag | `v3.1.0` |
8989
| `image.pullPolicy` | Nebula stats exporter imagePullPolicy | `IfNotPresent` |
9090
| `serviceAccount.create` | Specifies whether a service account should be created | `true` |
9191
| `serviceAccount.annotations` | Annotations to add to the service account | `{}` |

‎deploy/kubernetes/example-CN.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ _详情请见 [Install Nebula Cluster with helm](https://github.com/vesoft-inc/n
5959

6060
```shell
6161
$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
62-
--namespace=example1 --version=v0.0.6 \
62+
--namespace=example1 --version=v3.1.0 \
6363
--set serviceMonitor.enabled=true \
6464
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
6565

6666
$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
67-
--namespace=example2 --version=v0.0.6 \
67+
--namespace=example2 --version=v3.1.0 \
6868
--set serviceMonitor.enabled=true \
6969
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
7070
```

‎deploy/kubernetes/example.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,12 +59,12 @@ _See [Install Nebula Cluster with helm](https://github.com/vesoft-inc/nebula-ope
5959

6060
```shell
6161
$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
62-
--namespace=example1 --version=v0.0.6 \
62+
--namespace=example1 --version=v3.1.0 \
6363
--set serviceMonitor.enabled=true \
6464
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
6565

6666
$ helm install nebula-exporter nebula-exporter --repo https://vesoft-inc.github.io/nebula-stats-exporter/charts \
67-
--namespace=example2 --version=v0.0.6 \
67+
--namespace=example2 --version=v3.1.0 \
6868
--set serviceMonitor.enabled=true \
6969
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
7070
```

0 commit comments

Comments
 (0)