diff options
| author | Timotej S <6674623+underhood@users.noreply.github.com> | 2021-06-17 10:04:14 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-06-17 10:04:14 +0200 |
| commit | bbe3a4756a47643311e64ba8d375dfa6f8333825 (patch) | |
| tree | 8b093f85c8bcdffeb2c5945993819efe5b699742 | |
| parent | 2e88104ddc4c2bf3a365c87d463b62c659635a49 (diff) | |
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>
| -rw-r--r-- | aclk/README.md | 29 |
1 files changed, 26 insertions, 3 deletions
diff --git a/aclk/README.md b/aclk/README.md index 5c57e6b366..36f2c90f16 100644 --- a/aclk/README.md +++ b/aclk/README.md @@ -61,12 +61,36 @@ claiming](/claim/README.md#claim-through-a-proxy). You can configure following keys in the `netdata.conf` section `[cloud]`: ``` [cloud] - statistics = yes - query thread count = 2 + statistics = yes + query thread count = 2 + aclk implementation = legacy ``` - `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. - `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). +- `aclk implementation` - see [ACLK implementation](#aclk-implementation) section + +## ACLK implementation + +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`). + +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: + +``` +Features: + ACLK Next Generation: YES + ACLK Legacy: YES +``` + +To verify which ACLK implementation Netdata uses, visit the `/api/v1/info` endpoint on your local dashboard and check the `aclk-implementation` key. + +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)*. + +### Improvements of ACLK-NG over Legacy are: +- 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 +- No dependency on libwebsockets +- Lower latency and higher throughput +- More up to date, new features for Netdata Cloud are currently developed on top of ACLK-NG first ## Disable the ACLK @@ -149,4 +173,3 @@ If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf` Restart your Agent and [claim your node](/claim/README.md#how-to-claim-a-node). [](<>) - |