Libnetdata readmes learn (#14416)
* Add remaining libnetdata readmes to learn * Move all libnetdata readmes in learn under Developer/libnetdata libraries except for the main README * Add the moved array allocator
Chris Akritidis committed
Feb 3, 2023 at 08:11 UTC
aef3f517a58ce703e9a3cee43b0b701e476731cc
22 files changed
+99
-10
libnetdata/README.md
+4
@@ -1,6 +1,10 @@
1
<!--
2
title: "libnetdata"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/README.md
4
+sidebar_label: "libnetdata"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata"
8
-->
9
10
# libnetdata
libnetdata/adaptive_resortable_list/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/adapt
4
sidebar_label: "Adaptive Re-sortable List (ARL)"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# Adaptive Re-sortable List (ARL)
libnetdata/aral/README.md
+4
@@ -1,6 +1,10 @@
1
<!--
2
title: "Array Allocator"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/aral/README.md
4
+sidebar_label: "Array allocator"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# Array Allocator
libnetdata/avl/README.md
+4
@@ -1,6 +1,10 @@
1
<!--
2
title: "AVL"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/README.md
4
+sidebar_label: "AVL"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# AVL
libnetdata/buffer/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/buffe
4
sidebar_label: "BUFFER library"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# BUFFER
libnetdata/circular_buffer/README.md
+5
-1
@@ -1,6 +1,10 @@
1
<!--
2
-title: "circular_buffer"
2
+title: "Circular Buffer"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circular_buffer/README.md
4
+sidebar_label: "Circular Buffer"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# Circular Buffer
libnetdata/config/README.md
+1
-1
@@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/confi
4
sidebar_label: "Netdata ini config files"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# Netdata ini config files
libnetdata/dictionary/README.md
+1
-1
@@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/dicti
3
sidebar_label: "Dictionaries"
4
learn_status: "Published"
5
learn_topic_type: "Tasks"
6
-learn_rel_path: "Developers"
6
+learn_rel_path: "Developers/libnetdata libraries"
7
-->
8
9
# Dictionaries
libnetdata/ebpf/README.md
+8
@@ -1,5 +1,13 @@
1
<!--
2
+title "eBPF"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/ebpf/README.md
4
+sidebar_label: "eBPF"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
+# eBPF library
11
+
12
+Netdata's eBPF library supports the [eBPF collector](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
13
libnetdata/json/README.md
+4
@@ -1,6 +1,10 @@
1
<!--
2
title: "json"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/README.md
4
+sidebar_label: "json"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# json
libnetdata/july/README.md
+1
-1
@@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/july/
3
sidebar_label: "July interface"
4
learn_status: "Published"
5
learn_topic_type: "Tasks"
6
-learn_rel_path: "Developers"
6
+learn_rel_path: "Developers/libnetdata libraries"
7
-->
8
9
libnetdata/locks/README.md
+5
@@ -1,5 +1,10 @@
1
<!--
2
+title: "Locks"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/locks/README.md
4
+sidebar_label: "Locks"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
## How to trace netdata locks
libnetdata/log/README.md
+10
@@ -1,5 +1,15 @@
1
<!--
2
+title "Log"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/log/README.md
4
+sidebar_label: "Log"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
+# Log
11
+
12
+The netdata log library supports debug, info, error and fatal error logging.
13
+By default we have an access log, an error log and a collectors log.
14
+
15
libnetdata/onewayalloc/README.md
+2
-2
@@ -1,10 +1,10 @@
1
<!--
2
title: "One Way Allocator"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
4
-sidebar_label: "One Way Allocator"
4
+sidebar_label: "One way allocator"
5
learn_status: "Published"
6
learn_topic_type: "Tasks"
7
-learn_rel_path: "Developers"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# One Way Allocator
libnetdata/popen/README.md
+10
@@ -1,5 +1,15 @@
1
<!--
2
+title: "popen"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/popen/README.md
4
+sidebar_label: "popen"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
+# popen
11
+
12
+Process management library
13
+
14
+
15
libnetdata/procfile/README.md
+4
@@ -1,6 +1,10 @@
1
<!--
2
title: "PROCFILE"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procfile/README.md
4
+sidebar_label: "Procfile"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# PROCFILE
libnetdata/simple_pattern/README.md
+1
-1
@@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/simpl
5
sidebar_label: "Simple patterns"
6
learn_status: "Published"
7
learn_topic_type: "Tasks"
8
-learn_rel_path: "Developers"
8
+learn_rel_path: "Developers/libnetdata libraries"
9
-->
10
11
# Simple patterns
libnetdata/statistical/README.md
+7
@@ -1,5 +1,12 @@
1
<!--
2
+title: "Statistical functions"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/statistical/README.md
4
+sidebar_label: "Statistical functions"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
+# Statistical functions
11
12
+A library for easy and fast calculations of statistical measurements like average, median etc.
libnetdata/storage_number/README.md
+4
@@ -1,6 +1,10 @@
1
<!--
2
title: "Netdata storage number"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/storage_number/README.md
4
+sidebar_label: "Storage number"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# Netdata storage number
libnetdata/string/README.md
+6
-1
@@ -1,5 +1,10 @@
1
<!--
2
+title: "String"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/string/README.md
4
+sidebar_label: "String"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
# STRING
@@ -17,4 +22,4 @@ index lookup to find it.
22
23
Once there is a `STRING *`, the actual `const char *` can be accessed with `string2str()`.
24
20
-All STRING should be constant. Changing the contents of a `const char *` that has been acquired by `string2str()` should never happen.
\ No newline at end of file
25
+All STRING should be constant. Changing the contents of a `const char *` that has been acquired by `string2str()` should never happen.
libnetdata/threads/README.md
+7
@@ -1,5 +1,12 @@
1
<!--
2
+title: Threads
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/threads/README.md
4
+sidebar_label: "Threads"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
+# Threads
11
12
+Netdata uses a custom threads library
libnetdata/url/README.md
+9
@@ -1,5 +1,14 @@
1
<!--
2
+title: "URL"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/url/README.md
4
+sidebar_label: "URL"
5
+learn_status: "Published"
6
+learn_topic_type: "Tasks"
7
+learn_rel_path: "Developers/libnetdata libraries"
8
-->
9
10
+# URL
11
+
12
+The URL library contains common functions useful for URLs, like conversion from/to hex,
13
+URL encode/decode and query string parsing.
14