Skip to content

Commit

Permalink
add-note-related-to-tar-package-commands-for-bbox (#2673)
Browse files Browse the repository at this point in the history
* add-note-related-to-tar-package-commands-for-bbox

* Update 3.2.bbox-reviewer.md
  • Loading branch information
abby-cyber authored Mar 22, 2023
1 parent b4cb84d commit 2f75ec1
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 5 deletions.
2 changes: 1 addition & 1 deletion docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ NebulaGraph 黑匣子功能定期收集和归档操作系统和服务指标的

## 功能说明

黑匣子在服务器后台以进程运行并收集指标数据,目前仅收集操作系统运行时的一些性能指标(例如,CPU/Memory/Network IO 等相关指标),在未来,我们将支持收集服务指标。关于指标说明,参见[PROC](https://man7.org/linux/man-pages/man5/proc.5.html)
黑匣子在服务器后台以进程运行并收集指标数据,目前仅收集操作系统运行时的一些性能指标(例如,CPU/Memory/Network IO 等相关指标),在未来,我们将支持收集服务指标。关于指标说明,参见 [PROC](https://man7.org/linux/man-pages/man5/proc.5.html)

## 开启黑匣子

Expand Down
12 changes: 8 additions & 4 deletions docs-2.0/6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ NebulaGraph 与 Nebula-BBox 的版本兼容性如下:

## 部署 Nebula-BBox

支持多种部署方式,包括 RPM、DEB、Docker 等。本文以 RPM 部署为例介绍如何部署 Nebula-BBox。
支持多种部署方式,包括 RPM、DEB、TAR、Docker 等。本文以 RPM 部署为例介绍如何部署 Nebula-BBox。

1. 获取 RPM 安装包。

Expand All @@ -40,19 +40,23 @@ NebulaGraph 与 Nebula-BBox 的版本兼容性如下:

例如,`sudo rpm -i nebula-bbox-<version>.x86_64.rpm`

Nebula-BBox 以二进制文件的形式安装在默认路径`/usr/bin/`下。
Nebula-BBox 以二进制文件(文件名为`nebula-bbox`)的形式安装在默认路径`/usr/bin/`下。

## 使用 Nebula-BBox

用户可以执行`nebula-bbox -h/--help`查看 Nebula-BBox 的帮助信息。

!!! caution

对于安装在非默认路径(默认为`/usr/bin/`)下的 Nebula-BBox,执行`nebula-bbox`相关命令时,需指定 Nebula-BBox 的安装路径。例如,Nebula-BBox 安装在`/usr/bbox`下,则需执行`/usr/bbox/nebula-bbox -h`。

### 查看 Nebula-BBox 版本

执行`nebula-bbox version`查看 Nebula-BBox 的版本信息。

### 查看采集的所有指标

执行`nebula-bbox metrics`命令查看 Nebula-BBox 采集的所有指标。关于指标的详细信息,参见[PROC(5)](https://man7.org/linux/man-pages/man5/proc.5.html)
执行`nebula-bbox metrics`命令查看 Nebula-BBox 采集的所有指标。关于指标的详细信息,参见 [PROC(5)](https://man7.org/linux/man-pages/man5/proc.5.html)

### 查看黑匣子文件数据

Expand Down Expand Up @@ -87,7 +91,7 @@ nebula-bbox view [(-o|--output=)tui|csv] [--metrics name[,name ...]] [flags] (FI
|查看子目录和单个文件的所有指标数据|`nebula-bbox view /usr/local/nebula/black_box/<pid1> /usr/local/nebula/black_box/<pid2> /usr/local/nebula/black_box/<pid3>/black_box.<timestamp>.log`|
|查看单个文件中指定的指标数据|`nebula-bbox view --metrics <name> /usr/local/nebula/black_box/<pid>/black_box.<timestamp>.log`|
|在所有文件中查看指定的指标数据|`nebula-bbox view --metrics <name> /usr/local/nebula/black_box`|
|将所有文件中指定的指标数据导出为 CSV 文件|`nebula-bbox view --metrics <name1>[,<name2> ...] --output csv --output-file <csv_filename>.csv /usr/local/nebula/black_box`|
|将所有文件中指定的指标数据导出为 CSV 文件|`nebula-bbox view --metrics <name1>[,<name2> ...] --output csv --output-file <csv_filename>.csv /usr/local/nebula/black_box`|
|在所有文件中查看多个指定的指标数据|`nebula-bbox view --metrics <name1>[,<name2> ...] /usr/local/nebula/black_box`|
|查看北京时间 2022 年 9 月 6 日 12:00 起至现在的所有文件数据| `nebula-bbox view --start-time "Tue, 06 Sep 2022 12:00:00 +0800" /usr/local/nebula/black_box`<br>其中`Tue, 06 Sep 2022 12:00:00 +0800`的格式可替换成`2022-09-06T12:00:00+08:00``2022-09-06 04:00:00 +0800`|
|查看北京时间 2022 年 9 月 6 日 12:00 起 1 小时内的所有文件数据|`nebula-bbox view --start-time "Tue, 06 Sep 2022 12:00:00 +0800" --duration 1h /usr/local/nebula/black_box`,时间段单位支持`h``m``s`|
Expand Down

0 comments on commit 2f75ec1

Please sign in to comment.