Add new collectors to list (#10310)
Joel Hans committed
Dec 4, 2020 at 07:41 UTC
9dcd522954ed18162a07802ae4bc804bec281e57
1 file changed
+37
-7
collectors/COLLECTORS.md
+37
-7
@@ -10,9 +10,8 @@ Netdata uses collectors to help you gather metrics from your favorite applicatio
10
real-time, interactive charts. The following list includes collectors for both external services/applications and
11
internal system metrics.
12
13
-Read more about collectors and how to enable them in our [collectors documentation](/collectors/README.md), or use the
14
-[collector quickstart](/collectors/QUICKSTART.md) to figure out how to collect metrics from your favorite app/service
15
-with auto-detection and minimal configuration.
13
+Learn more about [how collectors work](/docs/collect/how-collectors-work.md), and then learn how to [enable or
14
+configure](/docs/collect/enable-configure.md) any of the below collectors using the same process.
15
16
Some collectors have both Go and Python versions as we continue our effort to migrate all collectors to Go. In these
17
cases, _Netdata always prioritizes the Go version_, and we highly recommend you use the Go versions for the best
@@ -22,9 +21,10 @@ If you want to use a Python version of a collector, you need to explicitly [disa
21
version](/docs/collect/enable-configure.md), and enable the Python version. Netdata then skips the Go version and
22
attempts to load the Python version and its accompanying configuration file.
23
25
-If you don't see the app/service you'd like to monitor here, check out our [GitHub
24
+If you don't see the app/service you'd like to monitor in this list, check out our [GitHub
25
issues](https://github.com/netdata/netdata/issues). Use the search bar to look for previous discussions about that
27
-collector—we may be looking for contributions from users such as yourself!
26
+collector—we may be looking for contributions from users such as yourself! If you don't see the collector there, make a
27
+[feature request](https://community.netdata.cloud/c/feature-requests/7/none) on our community forums.
28
29
- [Service and application collectors](#service-and-application-collectors)
30
- [APM (application performance monitoring)](#apm-application-performance-monitoring)
@@ -51,6 +51,7 @@ collector—we may be looking for contributions from users such as yourself!
51
- [Processes](#processes)
52
- [Resources](#resources)
53
- [Users](#users)
54
+- [Netdata collectors](#netdata-collectors)
55
- [Orchestrators](#orchestrators)
56
- [Third-party collectors](#third-party-collectors)
57
- [Etc](#etc)
@@ -194,7 +195,12 @@ configure any of these collectors according to your setup and infrastructure.
195
trip time.
196
- [Dnsmasq](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsmasq_dhcp/): Automatically
197
detects all configured `Dnsmasq` DHCP ranges and Monitor their utilization.
197
-- [dnsdist](/collectors/python.d.plugin/dnsdist/README.md): Collect load-balancer performance and health metrics.
198
+- [DNSdist (Go)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsdist/): Collect
199
+ load-balancer performance and health metrics.
200
+- [DNSdist (Python)](/collectors/python.d.plugin/dnsdist/README.md): Collect load-balancer performance and health
201
+ metrics.
202
+- [Dnsmasq DNS Forwarder](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsmasq/): Gather
203
+ queries, entries, operations, and events for the lightweight DNS forwarder.
204
- [dns_query](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/dnsquery/): Monitor the round
205
trip time for DNS queries in milliseconds.
206
- [DNS Query Time](/collectors/python.d.plugin/dns_query_time/README.md): Measure DNS query round trip time.
@@ -225,7 +231,13 @@ configure any of these collectors according to your setup and infrastructure.
231
- [Pi-hole](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/pihole/): Monitor basic (DNS
232
queries, clients, blocklist) and extended (top clients, top permitted, and blocked domains) statistics using the PHP
233
API.
228
-- [PowerDNS](/collectors/python.d.plugin/powerdns/README.md): Monitor authoritative server and recursor statistics.
234
+- [PowerDNS Authoritative Server
235
+ (Go)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/powerdns): Monitor one or more instances
236
+ of the nameserver software to collect questions, events, and latency metrics.
237
+- [PowerDNS Recursor (Go)](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/powerdns_recursor):
238
+ Gather incoming/outgoing questions, drops, timeouts, and cache usage from any number of DNS recursor instances.
239
+- [PowerDNS (Python)](/collectors/python.d.plugin/powerdns/README.md): Monitor authoritative server and recursor
240
+ statistics.
241
- [RetroShare](/collectors/python.d.plugin/retroshare/README.md): Monitor application bandwidth, peers, and DHT
242
metrics.
243
- [Tor](/collectors/python.d.plugin/tor/README.md): Capture traffic usage statistics using the Tor control port.
@@ -462,6 +474,24 @@ The Netdata Agent can collect these system- and hardware-level metrics using a v
474
- [User/group usage](/collectors/apps.plugin/README.md): Gather CPU, disk, memory, network, and other metrics per user
475
and user group using the `apps.plugin` collector.
476
477
+## Netdata collectors
478
+
479
+These collectors are recursive in nature, in that they monitor some function of the Netdata Agent itself. Some
480
+collectors are described only in code and associated charts in Netdata dashboards.
481
+
482
+- [ACLK (code only)](https://github.com/netdata/netdata/blob/master/aclk/aclk_stats.c): View whether a Netdata Agent
483
+ is connected to Netdata Cloud via the [ACLK](/aclk/README.md), the volume of queries, process times, and more.
484
+- [Alarms](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin/alarms): This collector creates an
485
+ <strong>Alarms</strong> menu with one line plot showing the alarm states of a Netdata Agent over time.
486
+- [Anomalies](https://learn.netdata.cloud/docs/agent/collectors/python.d.plugin/anomalies): This collector uses the
487
+ Python PyOD library to perform unsupervised anomaly detection on your Netdata charts and/or dimensions.
488
+- [Exporting (code only)](https://github.com/netdata/netdata/blob/master/exporting/send_internal_metrics.c): Gather
489
+ metrics on CPU utilization for the [exporting engine](/exporting/README.md), and specific metrics for each enabled
490
+ exporting connector.
491
+- [Global statistics (code only)](https://github.com/netdata/netdata/blob/master/daemon/global_statistics.c): See
492
+ metrics on the CPU utilization, network traffic, volume of web clients, API responses, database engine usage, and
493
+ more.
494
+
495
## Orchestrators
496
497
Plugin orchestrators organize and run many of the above collectors.