Skip to content

WebView

ZengJingtao edited this page Jan 30, 2023 · 3 revisions

ToplingDB web page display

Overview

In Home, we configure ToplingDB's embedded WebService through the http object, which displays various information of ToplingDB externally.

All pages can pass parameters through url, where the final parameter is html. html=1 means displaying as html page, while html=0 means displaying as json.

The general entry link is http://site:8081, and the content introduced later can be entered by clicking the corresponding link on the home page, and then select the specific display content.

image

2. db/dbname

The url of this page is in the form of: http://site:8081/db/dbname?html=1, which is the general entrance of all information of the db.

db's main page

You can enter by clicking db on the home page. The content is as follows:

image

strings

Click strings in the above figure to display the configuration content as follows:

image

Run compaction over Web

You can initiate a manual compaction through the url by adding the parameter compact=cfname to the url, and a full manual compaction will be initiated on cfname.

Executing compaction via url is disabled by default and needs to be enabled in the conf file: Setting permissions.web_compact to true is similar. Flush can also be initiated through url. The syntax is the same as compaction, but there is no need to configure permission.

3. CFProps cfname properties ${dbname/cfname}

The home page of this content

Enter by clicking props on the home page.

image

strings number metrics

image

Display status information of each layer

image

Drop-down sst content information

image

The url has several unique parameters

parameter name type meaning
sst int 0: don't show sst (default)
1: 1: display sst as text
2: The most detailed sst. The compacting sst will be highlighted
noint bool Whether to display int metrics. The default is true.
nozero bool Whether to display metrics whose int value is 0. the default is true.

4. TableFactory / table_factory

Display all TableFactories, among which the display of DispatchTable is more important. We display the Compaction state of DispatchTable at different levels by level.

The home page of this content

image

dispatch

The figure shows the auto-refreshing effect of the web page.

image

Note:

When using Distributed Compaction, the information from each CompactWorker will be aggregated and displayed, as if the compacts were executed locally. The page url supports the nozero parameter.

5. CompactionExecutorFactory / compaction_executor_factory

If distributed Compact is defined, it will be displayed, the uri parameter cols, if this parameter is defined, all CompactionWorker/stat tables will be displayed on this page, and cols indicates how many columns the table has.

The home page of this content

image

dcompact content

image

Click workers in the figure above to display the content

image

This page has two additional parameters

parameter name type meaning
version int The default is 0. Seting to 1 leads to information such as the git version number and compilation options of the worker displayed at the same time.
verbose int The default is 0. It is the detail level of display.
Clone this wiki locally