diff options
| author | Promise Akpan <akpanpromise@hotmail.com> | 2019-08-15 12:06:39 +0100 |
|---|---|---|
| committer | Chris Akritidis <43294513+cakrit@users.noreply.github.com> | 2019-08-15 13:06:39 +0200 |
| commit | f5006d51e8caf9148d393eb68d53dc9fcd28b7b6 (patch) | |
| tree | 03b757236d6b45e46813a4a875c77dc775e5f896 /libnetdata | |
| parent | 69172fd57472df75d877f43de2dcc693c48ab5c0 (diff) | |
Fix Markdown Lint warnings (#6664)
* make remark access all directories
* detailed fix after autofix by remark lint
* cross check autofix for this set of files
* crosscheck more files
* crosschecking and small fixes
* crosscheck autofixed md files
Diffstat (limited to 'libnetdata')
| -rw-r--r-- | libnetdata/README.md | 5 | ||||
| -rw-r--r-- | libnetdata/adaptive_resortable_list/README.md | 43 | ||||
| -rw-r--r-- | libnetdata/avl/README.md | 2 | ||||
| -rw-r--r-- | libnetdata/buffer/README.md | 2 | ||||
| -rw-r--r-- | libnetdata/clocks/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/config/README.md | 11 | ||||
| -rw-r--r-- | libnetdata/dictionary/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/eval/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/json/README.md | 4 | ||||
| -rw-r--r-- | libnetdata/locks/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/log/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/popen/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/procfile/README.md | 47 | ||||
| -rw-r--r-- | libnetdata/simple_pattern/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/socket/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/statistical/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/storage_number/README.md | 2 | ||||
| -rw-r--r-- | libnetdata/threads/README.md | 3 | ||||
| -rw-r--r-- | libnetdata/url/README.md | 3 |
19 files changed, 67 insertions, 82 deletions
diff --git a/libnetdata/README.md b/libnetdata/README.md index 2dd093ed54..8610cfd112 100644 --- a/libnetdata/README.md +++ b/libnetdata/README.md @@ -2,7 +2,4 @@ `libnetdata` is a collection of library code that is used by all Netdata `C` programs. - - - -[]() +[](<>) diff --git a/libnetdata/adaptive_resortable_list/README.md b/libnetdata/adaptive_resortable_list/README.md index 23c036bb55..0bb99b81cb 100644 --- a/libnetdata/adaptive_resortable_list/README.md +++ b/libnetdata/adaptive_resortable_list/README.md @@ -1,4 +1,3 @@ - # Adaptive Re-sortable List (ARL) This library allows Netdata to read a series of `name - value` pairs @@ -19,9 +18,9 @@ linked list will adapt at the next iteration. During initialization (just once), the caller: -- calls `arl_create()` to create the ARL +- calls `arl_create()` to create the ARL -- calls `arl_expect()` multiple times to register the expected keywords +- calls `arl_expect()` multiple times to register the expected keywords The library will call the `processor()` function (given to `arl_create()`), for each expected keyword found. @@ -34,16 +33,16 @@ Each `name` keyword may have a different `processor()` (by calling For each iteration through the data source, the caller: -- calls `arl_begin()` to initiate a data collection iteration. - This is to be called just ONCE every time the source is re-evaluated. +- calls `arl_begin()` to initiate a data collection iteration. + This is to be called just ONCE every time the source is re-evaluated. -- calls `arl_check()` for each entry read from the file. +- calls `arl_check()` for each entry read from the file. ### Cleanup When the caller exits: -- calls `arl_free()` to destroy this and free all memory. +- calls `arl_free()` to destroy this and free all memory. ### Performance @@ -68,22 +67,22 @@ In the following test we used alternative methods to process, **1M times**, a data source like `/proc/meminfo`, already tokenized, in memory, to extract the same number of expected metrics: -test|code|string comparison|number parsing|duration -:---:|:---:|:---:|:---:|:---:| -1|if-else-if-else-if|`strcmp()`|`strtoull()`|4630.337 ms -2|nested loops|inline `simple_hash()` and `strcmp()`|`strtoull()`|1597.481 ms -3|nested loops|inline `simple_hash()` and `strcmp()`|`str2ull()`|923.523 ms -4|if-else-if-else-if|inline `simple_hash()` and `strcmp()`|`strtoull()`| 854.574 ms -5|if-else-if-else-if|statement expression `simple_hash()` and `strcmp()`|`strtoull()`|912.013 ms -6|if-continue|inline `simple_hash()` and `strcmp()`|`strtoull()`|842.279 ms -7|if-else-if-else-if|inline `simple_hash()` and `strcmp()`|`str2ull()`|602.837 ms -8|ARL|ARL|`strtoull()`|350.360 ms -9|ARL|ARL|`str2ull()`|157.237 ms +|test|code|string comparison|number parsing|duration| +|:--:|:--:|:---------------:|:------------:|:------:| +|1|if-else-if-else-if|`strcmp()`|`strtoull()`|4630.337 ms| +|2|nested loops|inline `simple_hash()` and `strcmp()`|`strtoull()`|1597.481 ms| +|3|nested loops|inline `simple_hash()` and `strcmp()`|`str2ull()`|923.523 ms| +|4|if-else-if-else-if|inline `simple_hash()` and `strcmp()`|`strtoull()`|854.574 ms| +|5|if-else-if-else-if|statement expression `simple_hash()` and `strcmp()`|`strtoull()`|912.013 ms| +|6|if-continue|inline `simple_hash()` and `strcmp()`|`strtoull()`|842.279 ms| +|7|if-else-if-else-if|inline `simple_hash()` and `strcmp()`|`str2ull()`|602.837 ms| +|8|ARL|ARL|`strtoull()`|350.360 ms| +|9|ARL|ARL|`str2ull()`|157.237 ms| Compared to unoptimized code (test No 1: 4.6sec): - - - before ARL Netdata was using test No **7** with hashing and a custom `str2ull()` to achieve 602ms. - - the current ARL implementation is test No **9** that needs only 157ms (29 times faster vs unoptimized code, about 4 times faster vs optimized code). + +- before ARL Netdata was using test No **7** with hashing and a custom `str2ull()` to achieve 602ms. +- the current ARL implementation is test No **9** that needs only 157ms (29 times faster vs unoptimized code, about 4 times faster vs optimized code). [Check the source code of this test](../../tests/profile/benchmark-value-pairs.c). @@ -92,4 +91,4 @@ Compared to unoptimized code (test No 1: 4.6sec): Do not use ARL if the a name/keyword may appear more than once in the source data. -[]() +[](<>) diff --git a/libnetdata/avl/README.md b/libnetdata/avl/README.md index c4c72ff449..6a96884aef 100644 --- a/libnetdata/avl/README.md +++ b/libnetdata/avl/README.md @@ -9,4 +9,4 @@ use any memory allocations and their memory footprint is optimized In addition to the above, this version of AVL, provides versions using locks and traversal functions. -[]() +[](<>) diff --git a/libnetdata/buffer/README.md b/libnetdata/buffer/README.md index 48072e96e2..c89889c2a8 100644 --- a/libnetdata/buffer/README.md +++ b/libnetdata/buffer/README.md @@ -9,4 +9,4 @@ is just a lookup (it does not traverse the string). Netdata uses `BUFFER`s for preparing web responses and buffering data to be sent upstream or to backend databases. -[]() +[](<>) diff --git a/libnetdata/clocks/README.md b/libnetdata/clocks/README.md index c4215a7559..e4c424f397 100644 --- a/libnetdata/clocks/README.md +++ b/libnetdata/clocks/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/config/README.md b/libnetdata/config/README.md index 4fecef42c4..51216b6dbf 100644 --- a/libnetdata/config/README.md +++ b/libnetdata/config/README.md @@ -17,9 +17,9 @@ developers and the users. So, we did this: -1. No configuration is required to run Netdata -2. There are plenty of options to tweak -3. There is minimal documentation (or no at all) +1. No configuration is required to run Netdata +2. There are plenty of options to tweak +3. There is minimal documentation (or no at all) ## Why this works? @@ -33,7 +33,8 @@ In all places, in the code, there are both the `names` and their file, the default is used. The lookup is made using B-Trees and hashes (no string comparisons), so they are super fast. Also the `names` of the settings can be `my super duper setting that once set to yes, will turn the world upside down = no` -- so goodbye to most of the documentation involved. + +- so goodbye to most of the documentation involved. Next, Netdata can generate a valid configuration for the user to edit. No need to remember anything or copy and paste settings. Just get the @@ -45,4 +46,4 @@ When you get the configuration file from the server, there will be a comment above all `name = value` pairs the server does not use. So you know that whatever you wrote there, is not used. -[]() +[](<>) diff --git a/libnetdata/dictionary/README.md b/libnetdata/dictionary/README.md index 9c705227a4..5622b6914a 100644 --- a/libnetdata/dictionary/README.md +++ b/libnetdata/dictionary/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/eval/README.md b/libnetdata/eval/README.md index e7b4579a92..72b4089a98 100644 --- a/libnetdata/eval/README.md +++ b/libnetdata/eval/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/json/README.md b/libnetdata/json/README.md index fd6cb0f319..e723cede07 100644 --- a/libnetdata/json/README.md +++ b/libnetdata/json/README.md @@ -1,5 +1,5 @@ # json -`json` contains a parser for json strings, based on `jsmn` (https://github.com/zserge/jsmn), but case you have installed the JSON-C library, the installation script will prefer it, you can also force its use with `--enable-jsonc` in the compilation time. +`json` contains a parser for json strings, based on `jsmn` (<https://github.com/zserge/jsmn>), but case you have installed the JSON-C library, the installation script will prefer it, you can also force its use with `--enable-jsonc` in the compilation time. -[]() +[](<>) diff --git a/libnetdata/locks/README.md b/libnetdata/locks/README.md index 0f01e8c564..d06f5b0bdf 100644 --- a/libnetdata/locks/README.md +++ b/libnetdata/locks/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/log/README.md b/libnetdata/log/README.md index 28e3c3f720..d10f817ff8 100644 --- a/libnetdata/log/README.md +++ b/libnetdata/log/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/popen/README.md b/libnetdata/popen/README.md index 5a83b60229..63002d1cd1 100644 --- a/libnetdata/popen/README.md +++ b/libnetdata/popen/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/procfile/README.md b/libnetdata/procfile/README.md index de989ccb3d..7487e6c634 100644 --- a/libnetdata/procfile/README.md +++ b/libnetdata/procfile/README.md @@ -1,4 +1,3 @@ - # PROCFILE procfile is a library for reading text data files (i.e `/proc` files) in the fastest possible way. @@ -15,49 +14,49 @@ The library also supported quoted words (i.e. strings within of which the separa Initially the caller: -- calls `procfile_open()` to open the file and allocate the structures needed. +- calls `procfile_open()` to open the file and allocate the structures needed. ### Iterations For each iteration, the caller: -- calls `procfile_readall()` to read updated contents. - This call also rewinds (`lseek()` to 0) before reading it. +- calls `procfile_readall()` to read updated contents. + This call also rewinds (`lseek()` to 0) before reading it. + + For every file, a [BUFFER](../buffer/) is used that is automatically adjusted to fit + the entire file contents of the file. So the file is read with a single `read()` call + (providing atomicity / consistency when the data are read from the kernel). + + Once the data are read, 2 arrays of pointers are updated: - For every file, a [BUFFER](../buffer/) is used that is automatically adjusted to fit - the entire file contents of the file. So the file is read with a single `read()` call - (providing atomicity / consistency when the data are read from the kernel). + - a `words` array, pointing to each word in the data read + - a `lines` array, pointing to the first word for each line - Once the data are read, 2 arrays of pointers are updated: + This is highly optimized. Both arrays are automatically adjusted to + fit all contents and are updated in a single pass on the data. - - a `words` array, pointing to each word in the data read - - a `lines` array, pointing to the first word for each line + The library provides a number of macros: - This is highly optimized. Both arrays are automatically adjusted to - fit all contents and are updated in a single pass on the data. - - The library provides a number of macros: - - - `procfile_lines()` returns the # of lines read - - `procfile_linewords()` returns the # of words in the given line - - `procfile_word()` returns a pointer the given word # - - `procfile_line()` returns a pointer to the first word of the given line # - - `procfile_lineword()` returns a pointer to the given word # of the given line # + - `procfile_lines()` returns the # of lines read + - `procfile_linewords()` returns the # of words in the given line + - `procfile_word()` returns a pointer the given word # + - `procfile_line()` returns a pointer to the first word of the given line # + - `procfile_lineword()` returns a pointer to the given word # of the given line # ### Cleanup When the caller exits: -- calls `procfile_free()` to close the file and free all memory used. +- calls `procfile_free()` to close the file and free all memory used. ### Performance -- a **raspberry Pi 1** (the oldest single core one) can process 5.000+ `/proc` files per second. -- a **J1900 Celeron** processor can process 23.000+ `/proc` files per second per core. +- a **raspberry Pi 1** (the oldest single core one) can process 5.000+ `/proc` files per second. +- a **J1900 Celeron** processor can process 23.000+ `/proc` files per second per core. To achieve this kind of performance, the library tries to work in batches so that the code and the data are inside the processor's caches. This library is extensively used in Netdata and its plugins. -[]() +[](<>) diff --git a/libnetdata/simple_pattern/README.md b/libnetdata/simple_pattern/README.md index 12a3cc3291..53ed947e9b 100644 --- a/libnetdata/simple_pattern/README.md +++ b/libnetdata/simple_pattern/README.md @@ -34,5 +34,4 @@ Netdata stops processing to the first positive or negative match (left to right). If it is not matched by either positive or negative patterns, it is denied at the end. - -[]() +[](<>) diff --git a/libnetdata/socket/README.md b/libnetdata/socket/README.md index e427560757..ee1b97cfba 100644 --- a/libnetdata/socket/README.md +++ b/libnetdata/socket/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/statistical/README.md b/libnetdata/statistical/README.md index 184f82b4db..686299f79b 100644 --- a/libnetdata/statistical/README.md +++ b/libnetdata/statistical/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/storage_number/README.md b/libnetdata/storage_number/README.md index df058a2618..9f6c08e06f 100644 --- a/libnetdata/storage_number/README.md +++ b/libnetdata/storage_number/README.md @@ -9,4 +9,4 @@ have less decimal precision) and 3 bits for flags. This provides an extremely optimized memory footprint with just 0.0001% max accuracy loss. -[]() +[](<>) diff --git a/libnetdata/threads/README.md b/libnetdata/threads/README.md index 9f98ba16ea..478c746ebd 100644 --- a/libnetdata/threads/README.md +++ b/libnetdata/threads/README.md @@ -1,2 +1 @@ - -[]() +[](<>) diff --git a/libnetdata/url/README.md b/libnetdata/url/README.md index 7562ffb7ff..2f44d0e9ab 100644 --- a/libnetdata/url/README.md +++ b/libnetdata/url/README.md @@ -1,2 +1 @@ - -[]() +[](<>) |