ACLK #21236
ACLK #21236
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR significantly enhances the ACLK (Agent-Cloud Link) README documentation by adding comprehensive troubleshooting guidance. The update transforms a minimal README into a detailed operational guide with troubleshooting procedures, diagnostic commands, and FAQs.
Key changes:
- Converts blockquote-style warning to standard warning admonition syntax
- Adds extensive troubleshooting section covering connection diagnostics, status codes, error messages, and network testing
- Includes FAQ section with collapsible details for common ACLK questions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| sudo iptables -A OUTPUT -p tcp -d api.netdata.cloud --dport 443 -j ACCEPT | ||
| sudo iptables -A OUTPUT -p tcp -d app.netdata.cloud --dport 443 -j ACCEPT | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The iptables rules use -d with domain names (mqtt.netdata.cloud, etc.), which requires DNS resolution at rule creation time and creates static IP-based rules. This contradicts the earlier warning about IP addresses changing. Consider documenting that these rules will resolve to IPs at insertion time, or suggest using an alternative approach like using owner module to control by process, or explicitly noting that these examples need to be periodically updated.
| :::warning | |
| The above iptables rules use `-d` with domain names. **iptables resolves these domain names to IP addresses only at the time the rule is created.** If the IP addresses for these domains change (which is common for cloud services), the rules will not match future connections. You must manually update these rules whenever the IPs change. For dynamic allowlisting, use a firewall that supports domain-based rules, or automate IP updates. | |
| ::: |
| Claimed Id: <UUID> | ||
| Online: Yes/No | ||
| Cloud URL: https://app.netdata.cloud | ||
| ``` |
There was a problem hiding this comment.
It will also include
ACLK Proxy: none
Publish Latency: 140ms 500us
if a proxy is defined and the most recent publish message latency. The detailed publish latency chart is available under Netdata / Agent / Nework traffic
netdata.aclk_puback_latency
| Claimed Id: <UUID> | ||
| Online: Yes/No | ||
| Cloud URL: https://app.netdata.cloud | ||
| ``` |
There was a problem hiding this comment.
There is a also a
Pending PUBACKS: 0
Persisting non zero values here indicates network issues (latency). Messages we published but have not received an ACK from the broker. This information is also available under Netdata / Agent / Network Traffic
netdata.network_aclk_send_queue
updated aclk documentation (added troubleshooting section, faqs, format updated)