Black-box monitoring tool - NebulaGraph Black Box¶
The black-box monitoring tool NebulaGraph Black Box (short for Nebula-BBox) helps you view black-box monitoring data. This topic introduces how to use Nebula-BBox in Linux.
Nebula-BBox is only available for the NebulaGraph Enterprise Edition.
Nebula-BBox provides the following features:
- View monitoring metric data via TUI, Terminal User Interface.
- Export data as CSV files.
- View data in different dimensions.
- View data for one or more metrics.
- View data for a certain time.
- View data from one or more directories or files, or mixed.
- Support Linux, macOS, and Windows systems.
The version correspondence between NebulaGraph and Nebula-BBox is as follows.
You can deploy Nebula-BBox with RPM, DEB, or TAR packages, or with Docker. The following example uses RPM packages.
Obtain an RPM package.
Contact us to get the Nebula-BBox installation package.
sudo rpm -i <rpm>to install the package. For example:
sudo rpm -i nebula-bbox-<version>.x86_64.rpm
Nebula-BBox is installed in the default path
/usr/bin/in the form of a binary file
nebula-bbox -h/--help to view the available commands.
For Nebula-BBox installed in a non-default path (default path is
/usr/bin/), when executing
nebula-bbox related commands, it is necessary to specify the installation path of Nebula-BBox. For example, if Nebula-BBox is installed in
/usr/bbox, then you need to execute
View Nebula-BBox version¶
nebula-bbox version to view the version information of Nebula-BBox.
View black-box monitoring metrics¶
nebula-bbox metrics to view all the metrics collected by Nebula-BBox. For details about the description of metrics, see PROC(5).
View black-box monitoring data¶
You can use Nebula-BBox to view black-box monitoring file data. The syntax is as follows:
nebula-bbox view [(-o|--output=)tui|csv] [--metrics name[,name ...]] [flags] (FILE | DIRECTORY ...)
||Specifies the output display format. Optional values are
||Specifies one or multiple metrics. Optional values can be the metrics returned by running
When specifying multiple metrics, separate them with commas, for example
||You can specify other parameters:
The following examples assume that the NebulaGraph cluster is installed in the default path
/usr/local/nebula/ and the black-box monitoring data is stored in the default path
Before you want to specify one or multiple metrics, run
nebula-bbox metrics to view all the metrics that you can specify. For details, see the context above.
|View the data of all metrics by specifying a single file.||
|View the data of all metrics by specifying multiple files.||
|View the data of all metrics by specifying all files.||
|View the data of all metrics by specifying multiple subdirectories.||
|View the data of all metrics by specifying a subdirectory and a single file.||
|View the data of a specified metric in a single file.||
|View the data of a specified metric of all files.||
|View the data of specified metrics of all files in the form of a CSV file.||
|View the data of multiple specified metrics of all files.||
|View the data of all metrics of all files from noon September 6, 2022, Beijing time until now.||
The replacement of
|View the data of all metrics of all files within one hour starting from noon September 6, 2022, Beijing time.||
|View the data of all metrics of all files from noon September 6, 2022, Beijing time to 13:00 September 6, 2022, Beijing time.||
TUI mode and shortcuts¶
The TUI mode displays monitoring data in the form of a table. The first line of the table shows the time, service PID based on which metrics are collected, service name, and metric names.
You can use the following shortcuts to view data in TUI mode.
||Jump to the first column of the current line.|
||Jump to the last column of the current line.|
||Jump to the first line.|
||Jump to the last line.|
||View the detailed information in a table cell.|
||Quit displaying cell details.|
Q: Why does my TUI interface display as follows?
A: The situation shown above is due to a mismatch in the Linux system character set. Run
export LC_CTYPE="en_US.UTF-8" to solve the problem.