Skip to content

Commit

Permalink
update README (#51)
Browse files Browse the repository at this point in the history
  • Loading branch information
kqzh authored Oct 31, 2022
1 parent 59305a3 commit afecb94
Show file tree
Hide file tree
Showing 14 changed files with 34 additions and 28 deletions.
2 changes: 1 addition & 1 deletion Makefile
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
PROJECT="nebula-exporter"

GO ?= go
VERSION ?= v3.1.0
VERSION ?= v3.3.0
DockerUser=vesoft

ifeq (,$(shell go env GOBIN))
Expand Down
7 changes: 5 additions & 2 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@
- Metad 的 metrics
- Storaged 的 metrics
- Stroaged 内置 rocksdb 的 metrics
- Metad Listener 的 metrics
- Storaged Listener 的 metrics
- Draienrd 的 metrics

## 构建运行 exporter

Expand Down Expand Up @@ -71,12 +74,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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.0 --bare-metal --bare-metal-config=/config.yaml
```
## 在裸机上运行
Expand Down
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ The metrics currently collected are:
- Metad's metrics
- Storaged's metrics
- Storaged's rocksdb metrics
- Metad Listener's metrics
- Storaged Listener's metrics
- Draienrd's metrics

## Building and running the exporter

Expand Down Expand Up @@ -71,12 +74,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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.0 --bare-metal --bare-metal-config=/config.yaml
```
## Run on Bare Metal
Expand Down
12 changes: 6 additions & 6 deletions charts/index.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@ apiVersion: v1
entries:
nebula-exporter:
- apiVersion: v1
appVersion: v3.1.0
created: "2022-06-15T10:33:29.163134+08:00"
appVersion: v3.3.0
created: "2022-10-31T14:58:36.280027+08:00"
description: Nebula Graph stats exporter for prometheus
digest: 33acc20133ed85eb88ee7bcd0dc35d6079af589b693e1ba9030d5f298130e1af
digest: ea80a9ad538c244804df4c6049d5daf4caf5eb71dc5073ad74b465dbb01349e5
home: https://nebula-graph.io
icon: https://nebula-website-cn.oss-cn-hangzhou.aliyuncs.com/nebula-website/images/nebulagraph-logo.png
keywords:
Expand All @@ -28,6 +28,6 @@ entries:
sources:
- https://github.com/vesoft-inc/nebula
urls:
- https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-3.1.0.tgz
version: 3.1.0
generated: "2022-06-15T10:33:29.162252+08:00"
- https://vesoft-inc.github.io/nebula-stats-exporter/charts/nebula-exporter-3.3.0.tgz
version: 3.3.0
generated: "2022-10-31T14:58:36.277984+08:00"
Binary file removed charts/nebula-exporter-3.1.0.tgz
Binary file not shown.
Binary file added charts/nebula-exporter-3.3.0.tgz
Binary file not shown.
4 changes: 2 additions & 2 deletions charts/nebula-exporter/Chart.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
apiVersion: v1
appVersion: v3.1.0
appVersion: v3.3.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
Expand All @@ -22,4 +22,4 @@ maintainers:
name: nebula-exporter
sources:
- https://github.com/vesoft-inc/nebula
version: 3.1.0
version: 3.3.0
2 changes: 1 addition & 1 deletion charts/nebula-exporter/values.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ startUp:

image:
repository: vesoft/nebula-stats-exporter
tag: v3.1.0
tag: v3.3.0
pullPolicy: Always

serviceAccount:
Expand Down
4 changes: 2 additions & 2 deletions deploy/bare-metal/example-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.0 --bare-metal --bare-metal-config=/config.yaml
```

## 安装 prometheus
Expand Down
4 changes: 2 additions & 2 deletions deploy/bare-metal/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.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:v3.1.0 --bare-metal --bare-metal-config=/config.yaml
vesoft/nebula-stats-exporter:v3.3.0 --bare-metal --bare-metal-config=/config.yaml
```

## Install prometheus
Expand Down
6 changes: 3 additions & 3 deletions deploy/kubernetes/README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=v3.1.0 # Nebula Exporter 的 chart 版本
export CHART_VERSION=v3.3.0 # Nebula Exporter 的 chart 版本

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

注意:

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

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

Expand Down Expand Up @@ -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 | `v3.1.0` |
| `image.tag` | Nebula stats exporter image tag | `v3.3.0` |
| `image.pullPolicy` | Nebula stats exporter imagePullPolicy | `IfNotPresent` |
| `serviceAccount.create` | 指定是否应创建 service account | `true` |
| `serviceAccount.annotations` | 添加到 service account 的 annotations | `{}` |
Expand Down
6 changes: 3 additions & 3 deletions deploy/kubernetes/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=v3.1.0 # the chart version of Nebula Exporter
export CHART_VERSION=v3.3.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 \
Expand All @@ -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, v3.1.0. 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.3.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._

Expand Down Expand Up @@ -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 | `v3.1.0` |
| `image.tag` | Nebula stats exporter image tag | `v3.3.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 | `{}` |
Expand Down
4 changes: 2 additions & 2 deletions deploy/kubernetes/example-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=v3.1.0 \
--namespace=example1 --version=v3.3.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=v3.1.0 \
--namespace=example2 --version=v3.3.0 \
--set serviceMonitor.enabled=true \
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
```
Expand Down
4 changes: 2 additions & 2 deletions deploy/kubernetes/example.md
Original file line number Diff line number Diff line change
Expand Up @@ -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=v3.1.0 \
--namespace=example1 --version=v3.3.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=v3.1.0 \
--namespace=example2 --version=v3.3.0 \
--set serviceMonitor.enabled=true \
--set serviceMonitor.prometheusServiceMatchLabels.release=prometheus
```
Expand Down

0 comments on commit afecb94

Please sign in to comment.