From e8a700115990ebec5dddc2ffac54d9af41e9ca69 Mon Sep 17 00:00:00 2001 From: Akanksha Mahajan Date: Wed, 1 Sep 2021 19:38:08 -0700 Subject: [PATCH] Update branch as "main" in tools/advisor/README.md (#8744) Summary: Pull Request resolved: https://github.com/facebook/rocksdb/pull/8744 Reviewed By: ltamasi Differential Revision: D30716145 Pulled By: akankshamahajan15 fbshipit-source-id: c2fcaf9ddcae85a86c0f10496acab28cd795ff12 --- db/compaction/compaction_picker_level.cc | 2 +- tools/advisor/README.md | 24 ++++++++++++------------ 2 files changed, 13 insertions(+), 13 deletions(-) diff --git a/db/compaction/compaction_picker_level.cc b/db/compaction/compaction_picker_level.cc index 28c565b1b..0a70c89c0 100644 --- a/db/compaction/compaction_picker_level.cc +++ b/db/compaction/compaction_picker_level.cc @@ -385,7 +385,7 @@ uint32_t LevelCompactionBuilder::GetPathId( if (ioptions.level_compaction_dynamic_level_bytes) { // Currently, level_compaction_dynamic_level_bytes is ignored when // multiple db paths are specified. https://github.com/facebook/ - // rocksdb/blob/master/db/column_family.cc. + // rocksdb/blob/main/db/column_family.cc. // Still, adding this check to avoid accidentally using // max_bytes_for_level_multiplier_additional level_size = static_cast( diff --git a/tools/advisor/README.md b/tools/advisor/README.md index f1e7165e4..b02d7ec50 100644 --- a/tools/advisor/README.md +++ b/tools/advisor/README.md @@ -12,17 +12,17 @@ experts. ## Overview Experts share their wisdom as rules comprising of conditions and suggestions in the INI format (refer -[rules.ini](https://github.com/facebook/rocksdb/blob/master/tools/advisor/advisor/rules.ini)). +[rules.ini](https://github.com/facebook/rocksdb/blob/main/tools/advisor/advisor/rules.ini)). Users provide the Rocksdb configuration that they want to improve upon (as the familiar Rocksdb OPTIONS file — -[example](https://github.com/facebook/rocksdb/blob/master/examples/rocksdb_option_file_example.ini)) +[example](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini)) and the path of the file which contains Rocksdb logs and statistics. -The [Advisor](https://github.com/facebook/rocksdb/blob/master/tools/advisor/advisor/rule_parser_example.py) +The [Advisor](https://github.com/facebook/rocksdb/blob/main/tools/advisor/advisor/rule_parser_example.py) creates appropriate DataSource objects (for Rocksdb -[logs](https://github.com/facebook/rocksdb/blob/master/tools/advisor/advisor/db_log_parser.py), -[options](https://github.com/facebook/rocksdb/blob/master/tools/advisor/advisor/db_options_parser.py), -[statistics](https://github.com/facebook/rocksdb/blob/master/tools/advisor/advisor/db_stats_fetcher.py) etc.) -and provides them to the [Rules Engine](https://github.com/facebook/rocksdb/blob/master/tools/advisor/advisor/rule_parser.py). +[logs](https://github.com/facebook/rocksdb/blob/main/tools/advisor/advisor/db_log_parser.py), +[options](https://github.com/facebook/rocksdb/blob/main/tools/advisor/advisor/db_options_parser.py), +[statistics](https://github.com/facebook/rocksdb/blob/main/tools/advisor/advisor/db_stats_fetcher.py) etc.) +and provides them to the [Rules Engine](https://github.com/facebook/rocksdb/blob/main/tools/advisor/advisor/rule_parser.py). The Rules uses rules from experts to parse data-sources and trigger appropriate rules. The Advisor's output gives information about which rules were triggered, why they were triggered and what each of them suggests. Each suggestion @@ -48,9 +48,9 @@ python3 -m advisor.rule_parser_example --rules_spec=advisor/rules.ini --rocksdb_ Most important amongst all the input that the Advisor needs, are the rules spec and starting Rocksdb configuration. The configuration is provided as the -familiar Rocksdb Options file (refer [example](https://github.com/facebook/rocksdb/blob/master/examples/rocksdb_option_file_example.ini)). +familiar Rocksdb Options file (refer [example](https://github.com/facebook/rocksdb/blob/main/examples/rocksdb_option_file_example.ini)). The Rules spec is written in the INI format (more details in -[rules.ini](https://github.com/facebook/rocksdb/blob/master/tools/advisor/advisor/rules.ini)). +[rules.ini](https://github.com/facebook/rocksdb/blob/main/tools/advisor/advisor/rules.ini)). In brief, a Rule is made of conditions and is triggered when all its constituent conditions are triggered. When triggered, a Rule suggests changes @@ -61,8 +61,8 @@ For example, a log Condition (with 'source=LOG') is triggered if a particular 'regex' is found in the Rocksdb LOG files. As of now the Rules Engine supports 3 types of Conditions (and consequently data-sources): LOG, OPTIONS, TIME_SERIES. The TIME_SERIES data can be sourced from the -Rocksdb [statistics](https://github.com/facebook/rocksdb/blob/master/include/rocksdb/statistics.h) -or [perf context](https://github.com/facebook/rocksdb/blob/master/include/rocksdb/perf_context.h). +Rocksdb [statistics](https://github.com/facebook/rocksdb/blob/main/include/rocksdb/statistics.h) +or [perf context](https://github.com/facebook/rocksdb/blob/main/include/rocksdb/perf_context.h). For more information about the remaining command-line arguments, run: @@ -87,7 +87,7 @@ scope: col_fam: ## Running the tests Tests for the code have been added to the -[test/](https://github.com/facebook/rocksdb/tree/master/tools/advisor/test) +[test/](https://github.com/facebook/rocksdb/tree/main/tools/advisor/test) directory. For example, to run the unit tests for db_log_parser.py: ```shell