Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

rename blackbox #2760

Merged
merged 1 commit into from
May 16, 2023
Merged

rename blackbox #2760

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs-2.0/6.monitor-and-metrics/3.bbox/3.1.bbox.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# {{bbox.name}}介绍
# 黑匣子介绍

{{bbox.name}}（简称黑匣子）能定期收集和归档操作系统和服务指标的数据。当服务出现故障时，可以帮助用户在无直连网络的情况下快速定位问题和分析原因。
{{nebula.name}}自带黑匣子功能，可以定期收集和归档操作系统和服务指标的数据。当服务出现故障时，可以帮助用户在无直连网络的情况下快速定位问题和分析原因。

## 功能说明

Expand Down Expand Up @@ -34,6 +34,6 @@

黑匣子文件的生成间隔和保留时长可在{{nebula.name}}各个服务的配置文件的 **Black box 配置**中进行配置。有关配置文件详情，参见[配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)。

### 查看和分析黑匣子文件
### 查看黑匣子文件

可以通过 NebulaGraph Black Box 工具查看和分析黑匣子中二进制文件的数据，也可以使用该工具将二进制文件转换成 CSV 文件并导出查看。关于 NebulaGraph Black Box 工具的使用，参见[黑匣子工具 Nebula-BBox](3.2.bbox-reviewer.md)。
查看黑匣子二进制文件需要使用{{bbox.name}}工具，还可以使用该工具将二进制文件转换成 CSV 文件并导出查看。关于{{bbox.name}}的使用，参见[使用{{bbox.name}}](3.2.bbox-reviewer.md)。
40 changes: 20 additions & 20 deletions docs-2.0/6.monitor-and-metrics/3.bbox/3.2.bbox-reviewer.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# 黑匣子工具 NebulaGraph Black Box
# 使用{{bbox.name}}

NebulaGraph Black Box（简称 Nebula-BBox）是一个帮助用户查看和分析[黑匣子](3.1.bbox.md)数据的工具。本文介绍如何在 Linux 系统中使用 Nebula-BBox。
{{bbox.name}}是一个帮助用户查看和分析[黑匣子](3.1.bbox.md)数据的工具。本文介绍如何在 Linux 系统中使用{{bbox.name}}。

## Nebula-BBox 的功能
## {{bbox.name}}的功能

Nebula-BBox 提供了以下功能：
{{bbox.name}}提供了以下功能：

- 通过终端用户界面（Terminal User Interface, TUI）查看黑匣子数据。
- 将黑匣子数据导出为 CSV 文件。
Expand All @@ -16,47 +16,47 @@ Nebula-BBox 提供了以下功能：

## 版本兼容性

{{nebula.name}} 与 Nebula-BBox 的版本兼容性如下：
{{nebula.name}}与{{bbox.name}}的版本兼容性如下：

|{{nebula.name}}|Nebula-BBox|
|{{nebula.name}}|{{bbox.name}}|
|:---|:---|
|{{nebula.release}}|{{bbox.release}}|

## 部署 Nebula-BBox
## 部署{{bbox.name}}

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

1. 获取 RPM 安装包。

!!! enterpriseonly

[联系我们](https://www.nebula-graph.com.cn/contact)以获取 Nebula-BBox 的安装包。
[联系我们](https://www.nebula-graph.com.cn/contact)以获取{{bbox.name}}的安装包。

2. 使用`sudo rpm -i <rpm>`命令安装 RPM 包。

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

Nebula-BBox 以二进制文件（文件名为`nebula-bbox`）的形式安装在默认路径`/usr/bin/`下。
{{bbox.name}}以二进制文件（文件名为`nebula-bbox`）的形式安装在默认路径`/usr/bin/`下。

## 使用 Nebula-BBox
## 使用{{bbox.name}}

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

!!! caution

对于安装在非默认路径（默认为`/usr/bin/`）下的 Nebula-BBox，执行`nebula-bbox`相关命令时，需指定 Nebula-BBox 的安装路径。例如，Nebula-BBox 安装在`/usr/bbox`下，则需执行`/usr/bbox/nebula-bbox -h`。
对于安装在非默认路径（默认为`/usr/bin/`）下的{{bbox.name}}，执行`nebula-bbox`相关命令时，需指定{{bbox.name}}的安装路径。例如，{{bbox.name}}安装在`/usr/bbox`下，则需执行`/usr/bbox/nebula-bbox -h`。

### 查看 Nebula-BBox 版本
### 查看{{bbox.name}}版本

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

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

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

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

通过 Nebula-BBox，用户可以查看黑匣子文件的指标数据。语法如下：
通过{{bbox.name}}，用户可以查看黑匣子文件的指标数据。语法如下：

```bash
nebula-bbox view [(-o|--output=)tui|csv] [--metrics name[,name ...]] [flags] (FILE | DIRECTORY ...)
Expand All @@ -66,8 +66,8 @@ nebula-bbox view [(-o|--output=)tui|csv] [--metrics name[,name ...]] [flags] (FI

|参数|说明|
|:---|:---|
|`-o`，`--output`|指定 Nebula-BBox 显示数据的格式。可选值为`tui`和`csv`。未指定时默认值为`tui`。<br> `tui`：输出格式为终端用户界面（Terminal User Interface, TUI）。<br> `csv`：输出格式为 CSV 文件。|
|`--metrics`|指定 Nebula-BBox 输出的指标。可选值为`nebula-bbox metrics`命令输出的指标。未指定时默认值为所有指标。<br>指定多个指标时，用逗号分隔，如`--metrics <name>,<name>...`。|
|`-o`，`--output`|指定{{bbox.name}}显示数据的格式。可选值为`tui`和`csv`。未指定时默认值为`tui`。<br> `tui`：输出格式为终端用户界面（Terminal User Interface, TUI）。<br> `csv`：输出格式为 CSV 文件。|
|`--metrics`|指定{{bbox.name}}输出的指标。可选值为`nebula-bbox metrics`命令输出的指标。未指定时默认值为所有指标。<br>指定多个指标时，用逗号分隔，如`--metrics <name>,<name>...`。|
|`flags`|可定义其他的参数项：<br>`--output-file`：当`-o`或`--output`值为`csv`时需指定该参数，用于定义 CSV 文件的存储路径及文件名。<br>`--start-time`：当根据时间段过滤数据时，定义起始时间。<br>`--end-time`：当根据时间段过滤数据时，定义结束时间，和`--start-time`同时用。<br>`--duration`：当根据时间段过滤数据时，定义数据采集的时间周期，和`--start-time`同时用。不能和`--end-time`同时使用。|

#### 示例
Expand All @@ -76,7 +76,7 @@ nebula-bbox view [(-o|--output=)tui|csv] [--metrics name[,name ...]] [flags] (FI

!!! note

指定指标前，需先执行`nebula-bbox metrics`命令查看 Nebula-BBox 支持的指标。详情参见上文**查看采集的所有指标**。
指定指标前，需先执行`nebula-bbox metrics`命令查看{{bbox.name}}支持的指标。详情参见上文**查看采集的所有指标**。

|场景|示例|
|:---|:---|
Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -265,10 +265,10 @@ extra:
release: 3.4.1
tag: v3.4.1
# nav.ent.begin
name: 悦数备份&恢复
name: Backup&Restore
# nav.ent.end
# nav.comm.begin
name: NebulaGraph Backup&Restore
name: Backup&Restore
# nav.comm.end
agent:
release: 3.4.0
Expand Down