Updates the docu with info about dual ACLK (#11243)
* add info for dual aclk into readme * Update aclk/README.md Co-authored-by: Joel Hans <joel.g.hans@gmail.com>
Timotej S committed
Jun 17, 2021 at 10:04 UTC
bbe3a4756a47643311e64ba8d375dfa6f8333825
1 file changed
+26
-3
aclk/README.md
+26
-3
@@ -61,12 +61,36 @@ claiming](/claim/README.md#claim-through-a-proxy).
61
You can configure following keys in the `netdata.conf` section `[cloud]`:
62
```
63
[cloud]
64
- statistics = yes
65
- query thread count = 2
64
+ statistics = yes
65
+ query thread count = 2
66
+ aclk implementation = legacy
67
```
68
69
- `statistics` enables/disables ACLK related statistics and their charts. You can disable this to save some space in the database and slightly reduce memory usage of Netdata Agent.
70
- `query thread count` specifies the number of threads to process cloud queries. Increasing this setting is useful for nodes with many children (streaming), which can expect to handle more queries (and/or more complicated queries).
71
+- `aclk implementation` - see [ACLK implementation](#aclk-implementation) section
72
+
73
+## ACLK implementation
74
+
75
+Currently we are in process of switching ACLK to brand new technical stack called ACLK-NG. To choose your implementation, change the `aclk implementation` setting in your `netdata.conf` (accepted values `ng` or `legacy`).
76
+
77
+Before changing this value, check the desired implementation is available (determined at build time) by running `netdata -W buildinfo`. Following lines indicate which ACLK implementations are available:
78
+
79
+```
80
+Features:
81
+ ACLK Next Generation: YES
82
+ ACLK Legacy: YES
83
+```
84
+
85
+To verify which ACLK implementation Netdata uses, visit the `/api/v1/info` endpoint on your local dashboard and check the `aclk-implementation` key.
86
+
87
+New Netdata Cloud features will be implemented on top of ACLK-NG from this point on. ACLK Legacy is therefore kept as a fallback in case some users have issues with ACLK-NG or need to use features which are not yet available in ACLK-NG *(like IPv6 support and SOCKS proxy)*.
88
+
89
+### Improvements of ACLK-NG over Legacy are:
90
+- No dependency on custom patched `libmosquitto` (no bundling of libraries). Which should remove obstacles many GNU/Linux distribution package maintainers had trying to provide Netdata with Cloud support
91
+- No dependency on libwebsockets
92
+- Lower latency and higher throughput
93
+- More up to date, new features for Netdata Cloud are currently developed on top of ACLK-NG first
94
95
## Disable the ACLK
96
@@ -149,4 +173,3 @@ If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf`
173
Restart your Agent and [claim your node](/claim/README.md#how-to-claim-a-node).
174
175
[](<>)
152
-