mirror of
https://github.com/netdata/netdata.git
synced 2025-05-04 09:10:31 +00:00
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
This commit is contained in:
parent
75d25a95d6
commit
aef3f517a5
22 changed files with 99 additions and 10 deletions
libnetdata
README.md
adaptive_resortable_list
aral
avl
buffer
circular_buffer
config
dictionary
ebpf
json
july
locks
log
onewayalloc
popen
procfile
simple_pattern
statistical
storage_number
string
threads
url
|
@ -1,6 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "libnetdata"
|
title: "libnetdata"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/README.md
|
||||||
|
sidebar_label: "libnetdata"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# libnetdata
|
# libnetdata
|
||||||
|
|
|
@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/adapt
|
||||||
sidebar_label: "Adaptive Re-sortable List (ARL)"
|
sidebar_label: "Adaptive Re-sortable List (ARL)"
|
||||||
learn_status: "Published"
|
learn_status: "Published"
|
||||||
learn_topic_type: "Tasks"
|
learn_topic_type: "Tasks"
|
||||||
learn_rel_path: "Developers"
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Adaptive Re-sortable List (ARL)
|
# Adaptive Re-sortable List (ARL)
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "Array Allocator"
|
title: "Array Allocator"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/aral/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/aral/README.md
|
||||||
|
sidebar_label: "Array allocator"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Array Allocator
|
# Array Allocator
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "AVL"
|
title: "AVL"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/avl/README.md
|
||||||
|
sidebar_label: "AVL"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# AVL
|
# AVL
|
||||||
|
|
|
@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/buffe
|
||||||
sidebar_label: "BUFFER library"
|
sidebar_label: "BUFFER library"
|
||||||
learn_status: "Published"
|
learn_status: "Published"
|
||||||
learn_topic_type: "Tasks"
|
learn_topic_type: "Tasks"
|
||||||
learn_rel_path: "Developers"
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# BUFFER
|
# BUFFER
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "circular_buffer"
|
title: "Circular Buffer"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circular_buffer/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/circular_buffer/README.md
|
||||||
|
sidebar_label: "Circular Buffer"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Circular Buffer
|
# Circular Buffer
|
||||||
|
|
|
@ -4,7 +4,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/confi
|
||||||
sidebar_label: "Netdata ini config files"
|
sidebar_label: "Netdata ini config files"
|
||||||
learn_status: "Published"
|
learn_status: "Published"
|
||||||
learn_topic_type: "Tasks"
|
learn_topic_type: "Tasks"
|
||||||
learn_rel_path: "Developers"
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Netdata ini config files
|
# Netdata ini config files
|
||||||
|
|
|
@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/dicti
|
||||||
sidebar_label: "Dictionaries"
|
sidebar_label: "Dictionaries"
|
||||||
learn_status: "Published"
|
learn_status: "Published"
|
||||||
learn_topic_type: "Tasks"
|
learn_topic_type: "Tasks"
|
||||||
learn_rel_path: "Developers"
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Dictionaries
|
# Dictionaries
|
||||||
|
|
|
@ -1,5 +1,13 @@
|
||||||
<!--
|
<!--
|
||||||
|
title "eBPF"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/ebpf/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/ebpf/README.md
|
||||||
|
sidebar_label: "eBPF"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
# eBPF library
|
||||||
|
|
||||||
|
Netdata's eBPF library supports the [eBPF collector](https://github.com/netdata/netdata/blob/master/collectors/ebpf.plugin/README.md).
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "json"
|
title: "json"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/json/README.md
|
||||||
|
sidebar_label: "json"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# json
|
# json
|
||||||
|
|
|
@ -3,7 +3,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/july/
|
||||||
sidebar_label: "July interface"
|
sidebar_label: "July interface"
|
||||||
learn_status: "Published"
|
learn_status: "Published"
|
||||||
learn_topic_type: "Tasks"
|
learn_topic_type: "Tasks"
|
||||||
learn_rel_path: "Developers"
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
|
title: "Locks"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/locks/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/locks/README.md
|
||||||
|
sidebar_label: "Locks"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
## How to trace netdata locks
|
## How to trace netdata locks
|
||||||
|
|
|
@ -1,5 +1,15 @@
|
||||||
<!--
|
<!--
|
||||||
|
title "Log"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/log/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/log/README.md
|
||||||
|
sidebar_label: "Log"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
# Log
|
||||||
|
|
||||||
|
The netdata log library supports debug, info, error and fatal error logging.
|
||||||
|
By default we have an access log, an error log and a collectors log.
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,10 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "One Way Allocator"
|
title: "One Way Allocator"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/onewayallocator/README.md
|
||||||
sidebar_label: "One Way Allocator"
|
sidebar_label: "One way allocator"
|
||||||
learn_status: "Published"
|
learn_status: "Published"
|
||||||
learn_topic_type: "Tasks"
|
learn_topic_type: "Tasks"
|
||||||
learn_rel_path: "Developers"
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# One Way Allocator
|
# One Way Allocator
|
||||||
|
|
|
@ -1,5 +1,15 @@
|
||||||
<!--
|
<!--
|
||||||
|
title: "popen"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/popen/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/popen/README.md
|
||||||
|
sidebar_label: "popen"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
# popen
|
||||||
|
|
||||||
|
Process management library
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "PROCFILE"
|
title: "PROCFILE"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procfile/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/procfile/README.md
|
||||||
|
sidebar_label: "Procfile"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# PROCFILE
|
# PROCFILE
|
||||||
|
|
|
@ -5,7 +5,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/simpl
|
||||||
sidebar_label: "Simple patterns"
|
sidebar_label: "Simple patterns"
|
||||||
learn_status: "Published"
|
learn_status: "Published"
|
||||||
learn_topic_type: "Tasks"
|
learn_topic_type: "Tasks"
|
||||||
learn_rel_path: "Developers"
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Simple patterns
|
# Simple patterns
|
||||||
|
|
|
@ -1,5 +1,12 @@
|
||||||
<!--
|
<!--
|
||||||
|
title: "Statistical functions"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/statistical/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/statistical/README.md
|
||||||
|
sidebar_label: "Statistical functions"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
# Statistical functions
|
||||||
|
|
||||||
|
A library for easy and fast calculations of statistical measurements like average, median etc.
|
||||||
|
|
|
@ -1,6 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
title: "Netdata storage number"
|
title: "Netdata storage number"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/storage_number/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/storage_number/README.md
|
||||||
|
sidebar_label: "Storage number"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# Netdata storage number
|
# Netdata storage number
|
||||||
|
|
|
@ -1,5 +1,10 @@
|
||||||
<!--
|
<!--
|
||||||
|
title: "String"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/string/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/string/README.md
|
||||||
|
sidebar_label: "String"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
# STRING
|
# STRING
|
||||||
|
@ -17,4 +22,4 @@ index lookup to find it.
|
||||||
|
|
||||||
Once there is a `STRING *`, the actual `const char *` can be accessed with `string2str()`.
|
Once there is a `STRING *`, the actual `const char *` can be accessed with `string2str()`.
|
||||||
|
|
||||||
All STRING should be constant. Changing the contents of a `const char *` that has been acquired by `string2str()` should never happen.
|
All STRING should be constant. Changing the contents of a `const char *` that has been acquired by `string2str()` should never happen.
|
||||||
|
|
|
@ -1,5 +1,12 @@
|
||||||
<!--
|
<!--
|
||||||
|
title: Threads
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/threads/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/threads/README.md
|
||||||
|
sidebar_label: "Threads"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
# Threads
|
||||||
|
|
||||||
|
Netdata uses a custom threads library
|
||||||
|
|
|
@ -1,5 +1,14 @@
|
||||||
<!--
|
<!--
|
||||||
|
title: "URL"
|
||||||
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/url/README.md
|
custom_edit_url: https://github.com/netdata/netdata/edit/master/libnetdata/url/README.md
|
||||||
|
sidebar_label: "URL"
|
||||||
|
learn_status: "Published"
|
||||||
|
learn_topic_type: "Tasks"
|
||||||
|
learn_rel_path: "Developers/libnetdata libraries"
|
||||||
-->
|
-->
|
||||||
|
|
||||||
|
# URL
|
||||||
|
|
||||||
|
The URL library contains common functions useful for URLs, like conversion from/to hex,
|
||||||
|
URL encode/decode and query string parsing.
|
||||||
|
|
||||||
|
|
Loading…
Add table
Add a link
Reference in a new issue