Skip to content

Commit

Permalink
Ingest new documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
hugovalente-pm authored Aug 7, 2022
1 parent c8a1bff commit bea66d4
Show file tree
Hide file tree
Showing 109 changed files with 1,815 additions and 1,187 deletions.
20 changes: 15 additions & 5 deletions docs/agent/aclk.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,25 @@ The Agent-Cloud link (ACLK) is the mechanism responsible for securely connecting
through Netdata Cloud. The ACLK establishes an outgoing secure WebSocket (WSS) connection to Netdata Cloud on port
`443`. The ACLK is encrypted, safe, and _is only established if you connect your node_.

The Cloud App lives at app.netdata.cloud which currently resolves to 35.196.244.138. However, this IP or range of
IPs can change without notice. Watch this page for updates.
The Cloud App lives at app.netdata.cloud which currently resolves to the following list of IPs:

- 54.198.178.11
- 44.207.131.212
- 44.196.50.41

:::caution

This list of IPs can change without notice, we strongly advise you to whitelist the domain `app.netdata.cloud`, if
this is not an option in your case always verify the current domain resolution (e.g via the `host` command).

:::

For a guide to connecting a node using the ACLK, plus additional troubleshooting and reference information, read our [get
started with Cloud](/docs/cloud/get-started) guide or the full [connect to Cloud
documentation](/docs/agent/claim).

## Data privacy
[Data privacy](https://netdata.cloud/data-privacy/) is very important to us. We firmly believe that your data belongs to
[Data privacy](https://netdata.cloud/privacy/) is very important to us. We firmly believe that your data belongs to
you. This is why **we don't store any metric data in Netdata Cloud**.

All the data that you see in the web browser when using Netdata Cloud, is actually streamed directly from the Netdata Agent to the Netdata Cloud dashboard.
Expand Down Expand Up @@ -50,12 +60,12 @@ You can configure following keys in the `netdata.conf` section `[cloud]`:
[cloud]
statistics = yes
query thread count = 2
mqtt5 = no
mqtt5 = yes
```

- `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).
- `mqtt5` enables the new MQTT5 protocol implementation in the Agent. Currently a technical preview.
- `mqtt5` allows disabling the new MQTT5 implementation which is used now by default in case of issues. This option will be removed in future stable release.

## Disable the ACLK

Expand Down
2 changes: 1 addition & 1 deletion docs/agent/anonymous-statistics.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/anonymous-s
By default, Netdata collects anonymous usage information from the open-source monitoring agent using the open-source
product analytics platform [PostHog](https://github.com/PostHog/posthog). We use their [cloud enterprise platform](https://posthog.com/product).

We are strongly committed to your [data privacy](https://netdata.cloud/data-privacy/).
We are strongly committed to your [data privacy](https://netdata.cloud/privacy/).

We use the statistics gathered from this information for two purposes:

Expand Down
257 changes: 123 additions & 134 deletions docs/agent/changelog.md

Large diffs are not rendered by default.

49 changes: 27 additions & 22 deletions docs/agent/collectors/collectors.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,18 @@ version](/docs/collect/enable-configure), and enable the Python version. Netdata
attempts to load the Python version and its accompanying configuration file.

If you don't see the app/service you'd like to monitor in this list:
- Check out our [GitHub issues](https://github.com/netdata/netdata/issues). Use the search bar to look for previous discussions about that
collector—we may be looking for assistance from users such as yourself!
- If you don't see the collector there, you can make a [feature request](https://github.com/netdata/netdata/issues/new/choose) on GitHub.
- If you have basic software development skills, you can add your own plugin in [Go](/docs/agent/collectors/go.d.plugin#how-to-develop-a-collector) or [Python](/guides/python-collector)

- Check out our [GitHub issues](https://github.com/netdata/netdata/issues). Use the search bar to look for previous
discussions about that collector—we may be looking for assistance from users such as yourself!
- If you don't see the collector there, you can make
a [feature request](https://github.com/netdata/netdata/issues/new/choose) on GitHub.
- If you have basic software development skills, you can add your own plugin
in [Go](/docs/agent/collectors/go.d.plugin#how-to-develop-a-collector)
or [Python](/guides/python-collector)

Supported Collectors List:
- [Service and application collectors](#service-and-application-collectors)

- [Service and application collectors](#service-and-application-collectors)
- [Generic](#generic)
- [APM (application performance monitoring)](#apm-application-performance-monitoring)
- [Containers and VMs](#containers-and-vms)
Expand All @@ -44,7 +49,7 @@ Supported Collectors List:
- [Search](#search)
- [Storage](#storage)
- [Web](#web)
- [System collectors](#system-collectors)
- [System collectors](#system-collectors)
- [Applications](#applications)
- [Disks and filesystems](#disks-and-filesystems)
- [eBPF](#ebpf)
Expand All @@ -55,10 +60,10 @@ Supported Collectors List:
- [Processes](#processes)
- [Resources](#resources)
- [Users](#users)
- [Netdata collectors](#netdata-collectors)
- [Orchestrators](#orchestrators)
- [Third-party collectors](#third-party-collectors)
- [Etc](#etc)
- [Netdata collectors](#netdata-collectors)
- [Orchestrators](#orchestrators)
- [Third-party collectors](#third-party-collectors)
- [Etc](#etc)

## Service and application collectors

Expand Down Expand Up @@ -169,9 +174,8 @@ configure any of these collectors according to your setup and infrastructure.
plugins metrics from an endpoint provided by `in_monitor plugin`.
- [Logstash](/docs/agent/collectors/go.d.plugin/modules/logstash/): Monitor JVM threads,
memory usage, garbage collection statistics, and more.
- [OpenVPN status logs](/docs/agent/collectors/python.d.plugin/ovpn_status_log): Parse server log files and provide
summary
(client, traffic) metrics.
- [OpenVPN status logs](/docs/agent/collectors/go.d.plugin/modules/openvpn_status_log): Parse
server log files and provide summary (client, traffic) metrics.
- [Squid web server logs](/docs/agent/collectors/go.d.plugin/modules/squidlog/): Tail Squid
access logs to return the volume of requests, types of requests, bandwidth, and much more.
- [Web server logs (Go version for Apache,
Expand Down Expand Up @@ -200,8 +204,8 @@ configure any of these collectors according to your setup and infrastructure.

- [Bind 9](/docs/agent/collectors/go.d.plugin/modules/bind/): Collect nameserver summary
performance statistics via a web interface (`statistics-channels` feature).
- [Chrony](/docs/agent/collectors/python.d.plugin/chrony): Monitor the precision and statistics of a local `chronyd`
server.
- [Chrony](/docs/agent/collectors/go.d.plugin/modules/chrony): Monitor the precision and
statistics of a local `chronyd` server.
- [CoreDNS](/docs/agent/collectors/go.d.plugin/modules/coredns/): Measure DNS query round
trip time.
- [Dnsmasq](/docs/agent/collectors/go.d.plugin/modules/dnsmasq_dhcp/): Automatically
Expand Down Expand Up @@ -251,13 +255,14 @@ configure any of these collectors according to your setup and infrastructure.

- [AM2320](/docs/agent/collectors/python.d.plugin/am2320): Monitor sensor temperature and humidity.
- [Access point](/docs/agent/collectors/charts.d.plugin/ap): Monitor client, traffic and signal metrics using the `aw`
tool.
tool.
- [APC UPS](/docs/agent/collectors/charts.d.plugin/apcupsd): Capture status information using the `apcaccess` tool.
- [Energi Core](/docs/agent/collectors/go.d.plugin/modules/energid): Monitor
blockchain indexes, memory usage, network usage, and transactions of wallet instances.
blockchain indexes, memory usage, network usage, and transactions of wallet instances.
- [UPS/PDU](/docs/agent/collectors/charts.d.plugin/nut): Read the status of UPS/PDU devices using the `upsc` tool.
- [SNMP devices](/docs/agent/collectors/go.d.plugin/modules/snmp): Gather data using the SNMP protocol.
- [1-Wire sensors](/docs/agent/collectors/python.d.plugin/w1sensor): Monitor sensor temperature.
- [SNMP devices](/docs/agent/collectors/go.d.plugin/modules/snmp): Gather data using the SNMP
protocol.
- [1-Wire sensors](/docs/agent/collectors/python.d.plugin/w1sensor): Monitor sensor temperature.

### Search

Expand Down Expand Up @@ -482,9 +487,9 @@ Plugin orchestrators organize and run many of the above collectors.
If you're interested in developing a new collector that you'd like to contribute to Netdata, we highly recommend using
the `go.d.plugin`.

- [go.d.plugin](https://github.com/netdata/go.d.plugin): An orchestrator for data collection modules written in `go`.
- [python.d.plugin](/docs/agent/collectors/python.d.plugin): An orchestrator for data collection modules written in `python` v2/v3.
- [charts.d.plugin](/docs/agent/collectors/charts.d.plugin): An orchestrator for data collection modules written in `bash` v4+.
- [go.d.plugin](https://github.com/netdata/go.d.plugin): An orchestrator for data collection modules written in `go`.
- [python.d.plugin](/docs/agent/collectors/python.d.plugin): An orchestrator for data collection modules written in `python` v2/v3.
- [charts.d.plugin](/docs/agent/collectors/charts.d.plugin): An orchestrator for data collection modules written in `bash` v4+.

## Third-party collectors

Expand Down
4 changes: 1 addition & 3 deletions docs/agent/collectors/ebpf.plugin.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ sidebar_label: "eBPF"



The Netdata Agent provides many [eBPF](https://ebpf.io/what-is-ebpf/) programs to help you troubleshoot and debug how applications interact with the Linux kernel. The `ebpf.plugin` uses [tracepoints, trampoline, and2 kprobes](#data-collection) to collect a wide array of high value data about the host that would otherwise be impossible to capture.
The Netdata Agent provides many [eBPF](https://ebpf.io/what-is-ebpf/) programs to help you troubleshoot and debug how applications interact with the Linux kernel. The `ebpf.plugin` uses [tracepoints, trampoline, and2 kprobes](#how-netdata-collects-data-using-probes-and-tracepoints) to collect a wide array of high value data about the host that would otherwise be impossible to capture.

> ❗ eBPF monitoring only works on Linux systems and with specific Linux kernels, including all kernels newer than `4.11.0`, and all kernels on CentOS 7.6 or later. For kernels older than `4.11.0`, improved support is in active development.
Expand All @@ -20,8 +20,6 @@ For hands-on configuration and troubleshooting tips see our [tutorial on trouble
<figcaption>An example of virtual file system (VFS) charts made possible by the eBPF collector plugin.</figcaption>
</figure>

<a id="data-collection"> </a>

## How Netdata collects data using probes and tracepoints

Netdata uses the following features from the Linux kernel to run eBPF programs:
Expand Down
Loading

0 comments on commit bea66d4

Please sign in to comment.