From b591aa3e645603810fa8dc7f27bc2fb9a68acf75 Mon Sep 17 00:00:00 2001 From: rany Date: Mon, 18 Sep 2023 11:42:03 +0300 Subject: [PATCH] Reformat markdown documents Signed-off-by: rany --- ANALYSIS.md | 9 ++++---- CHANGELOG.md | 24 ++++++++++---------- INSTALLATION.md | 60 ++++++++++++++++++++++++++++--------------------- 3 files changed, 52 insertions(+), 41 deletions(-) diff --git a/ANALYSIS.md b/ANALYSIS.md index 7be477a6..52451647 100644 --- a/ANALYSIS.md +++ b/ANALYSIS.md @@ -7,9 +7,8 @@ of the algorithm. ## Viewing a simple summary of key statistics on the command line -A simple summary of the key statistics can be generated on the -command line so long as `output_reflector_stats` is enabled -using e.g.: +A simple summary of the key statistics can be generated on the command +line so long as `output_reflector_stats` is enabled using e.g.: ```bash tail -f /var/log/cake-autorate.primary.log | grep -e SUMMARY @@ -84,6 +83,8 @@ octave -qf --eval 'fn_parse_autorate_log("./*primary*log.gz", "./output.pdf")' ### Prometheus cake-autorate exporter -Check out [bairhys](https://github.com/bairhys)' [prometheus-cake-autorate-exporter](https://github.com/bairhys/prometheus-cake-autorate-exporter) for beautiful, continuous plotting of cake-autorate statistics: +Check out [bairhys](https://github.com/bairhys)' +[prometheus-cake-autorate-exporter](https://github.com/bairhys/prometheus-cake-autorate-exporter) +for beautiful, continuous plotting of cake-autorate statistics: diff --git a/CHANGELOG.md b/CHANGELOG.md index ee4530f2..62b0cded 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,19 +9,19 @@ more about cake-autorate. This is the history of changes. ## 2023-09-18 - Version 3.1.0 -- Removed consulting the achieved rate when setting the new shaper -rate on detection of bufferbloat. Whilst the achieved transfer rate -on bufferbloat detection can give insight into the connection capacity, -leveraging this effectively proved troublesome. +- Removed consulting the achieved rate when setting the new shaper + rate on detection of bufferbloat. Whilst the achieved transfer rate + on bufferbloat detection can give insight into the connection + capacity, leveraging this effectively proved troublesome. - Introduced scaling of shaper rate reduction on bufferbloat based on -the average OWD delta taken across the bufferbloat detection window -as a portion of a user configurable average OWD delta threshold. -- Amended existing DATA log lines for more consistency and to incorporate -the average OWD deltas and compensated thresholds. -- Introduced new SUMMARY log lines to offer a simple way to see a -summary of key statistics using: `grep -e SUMMARY`. -- Utilities that read from log file(s) will need to be updated to -take into account the changes to the logging. + the average OWD delta taken across the bufferbloat detection window + as a portion of a user configurable average OWD delta threshold. +- Amended existing DATA log lines for more consistency and to + incorporate the average OWD deltas and compensated thresholds. +- Introduced new SUMMARY log lines to offer a simple way to see a + summary of key statistics using: `grep -e SUMMARY`. +- Utilities that read from log file(s) will need to be updated to take + into account the changes to the logging. - Fixed startup crash when log to file is disabled. - Fixed minor issue relating to parser termination traps. diff --git a/INSTALLATION.md b/INSTALLATION.md index f4f29f4b..8c8463b5 100644 --- a/INSTALLATION.md +++ b/INSTALLATION.md @@ -47,26 +47,27 @@ required tools. To use it: obtained, for example, by consulting the configured SQM settings in LuCI or by examining the output of `tc qdisc ls`. - | Variable | Setting | - | -------: | :----------------------------------------------- | - | `dl_if` | Interface that downloads data (often _ifb4-wan_) | - | `ul_if` | Interface that uploads (often _wan_) | + | Variable | Setting | | -------: | + :----------------------------------------------- | | `dl_if` | + Interface that downloads data (often _ifb4-wan_) | | `ul_if` | + Interface that uploads (often _wan_) | - Set bandwidth variables as described in _config.primary.sh_. - | Type | Download | Upload | - | ---: | :------------------------- | :------------------------- | - | Min. | `min_dl_shaper_rate_kbps` | `min_ul_shaper_rate_kbps` | - | Base | `base_dl_shaper_rate_kbps` | `base_ul_shaper_rate_kbps` | - | Max. | `max_dl_shaper_rate_kbps` | `max_ul_shaper_rate_kbps` | + | Type | Download | Upload | | ---: | :------------------------- | + :------------------------- | | Min. | `min_dl_shaper_rate_kbps` | + `min_ul_shaper_rate_kbps` | | Base | `base_dl_shaper_rate_kbps` | + `base_ul_shaper_rate_kbps` | | Max. | `max_dl_shaper_rate_kbps` | + `max_ul_shaper_rate_kbps` | - Choose whether cake-autorate should adjust the shaper rates (disable for monitoring only): - | Variable | Setting | - | ----------------------: | :----------------------------------------- | - | `adjust_dl_shaper_rate` | enable (1) or disable (0) download shaping | - | `adjust_ul_shaper_rate` | enable (1) or disable (0) upload shaping | + | Variable | Setting | | ----------------------: | + :----------------------------------------- | | + `adjust_dl_shaper_rate` | enable (1) or disable (0) download + shaping | | `adjust_ul_shaper_rate` | enable (1) or disable (0) + upload shaping | - The other configuration file - _defaults.sh_ - has sensible default settings. After cake-autorate has been installed and is running, you @@ -81,18 +82,27 @@ required tools. To use it: - The following variables control logging: - | Variable | Setting | - | -----------------------------: | :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | - | `output_processing_stats` | If non-zero, log the results of every iteration through the process | - | `output_load_stats` | If non-zero, log the log the measured achieved rates of upload and download | - | `output_reflector_stats` | If non-zero, log the statistics generated in respect of reflector health monitoring | - | `output_summary_stats` | If non-zero, log a summary with the key statistics | - | `output_cake_changes` | If non-zero, log when changes are made to CAKE settings via `tc` - this shows when cake-autorate is adjusting the shaper | - | `debug` | If non-zero, debug lines will be output | - | `log_DEBUG_messages_to_syslog` | If non-zero, log lines will also get sent to the system log | - | `log_to_file` | If non-zero, log lines will be sent to /tmp/cake-autorate.log regardless of whether printing to console and after every write the log file will be rotated f either `log_file_max_time_mins` have elapsed or `log_file_max_size_KB` has been exceeded | - | `log_file_max_time_mins` | Number of minutes to elapse between log file rotaton | - | `log_file_max_size_KB` | Number of KB (i.e. bytes/1024) worth of log lines between log file rotations | + | Variable | Setting | | -----------------------------: | + :---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- + | | `output_processing_stats` | If non-zero, log the results of + every iteration through the process | | `output_load_stats` | If + non-zero, log the log the measured achieved rates of upload and + download | | `output_reflector_stats` | If non-zero, log the + statistics generated in respect of reflector health monitoring | | + `output_summary_stats` | If non-zero, log a summary with the key + statistics | | `output_cake_changes` | If non-zero, log when + changes are made to CAKE settings via `tc` - this shows when + cake-autorate is adjusting the shaper | | `debug` | If non-zero, + debug lines will be output | | `log_DEBUG_messages_to_syslog` | If + non-zero, log lines will also get sent to the system log | | + `log_to_file` | If non-zero, log lines will be sent to + /tmp/cake-autorate.log regardless of whether printing to console + and after every write the log file will be rotated f either + `log_file_max_time_mins` have elapsed or `log_file_max_size_KB` + has been exceeded | | `log_file_max_time_mins` | Number of minutes + to elapse between log file rotaton | | `log_file_max_size_KB` | + Number of KB (i.e. bytes/1024) worth of log lines between log file + rotations | ## Manual testing