add clickhouse third party collector and install instructions (#14021)
add clickhouse and third party install instruction
Andrew Maguire committed
Dec 7, 2022 at 17:49 UTC
bf8f277746cf912b2e12c5c5248866cd126767b9
1 file changed
+36
collectors/COLLECTORS.md
+36
@@ -499,6 +499,41 @@ the `go.d.plugin`.
499
These collectors are developed and maintained by third parties and, unlike the other collectors, are not installed by
500
default. To use a third-party collector, visit their GitHub/documentation page and follow their installation procedures.
501
502
+<details>
503
+<summary>Typical third party Python collector installation instructions</summary>
504
+<br>
505
+In general the below steps should be sufficient to use a third party collector.
506
+
507
+1. Download collector code file into [folder expected by Netdata](https://learn.netdata.cloud/docs/agent/collectors/plugins.d#environment-variables).
508
+2. Download default collector configuration file into [folder expected by Netdata](https://learn.netdata.cloud/docs/agent/collectors/plugins.d#environment-variables).
509
+3. [Edit configuration file](/docs/collect/enable-configure#configure-a-collector) from step 2 if required.
510
+4. [Enable collector](/docs/collect/enable-configure#enable-a-collector-or-its-orchestrator).
511
+5. [Restart Netdata](/docs/configure/start-stop-restart.md)
512
+
513
+For example below are the steps to enable the [Python ClickHouse collector](https://github.com/netdata/community/tree/main/collectors/python.d.plugin/clickhouse).
514
+
515
+```bash
516
+# download python collector script to /usr/libexec/netdata/python.d/
517
+$ sudo wget https://raw.githubusercontent.com/netdata/community/main/collectors/python.d.plugin/clickhouse/clickhouse.chart.py -O /usr/libexec/netdata/python.d/clickhouse.chart.py
518
+
519
+# (optional) download default .conf to /etc/netdata/python.d/
520
+$ sudo wget https://raw.githubusercontent.com/netdata/community/main/collectors/python.d.plugin/clickhouse/clickhouse.conf -O /etc/netdata/python.d/clickhouse.conf
521
+
522
+# enable collector by adding line a new line with "clickhouse: yes" to /etc/netdata/python.d.conf file
523
+# this will apend to the file if it already exists or create it if not
524
+$ sudo echo "clickhouse: yes" >> /etc/netdata/python.d.conf
525
+
526
+# (optional) edit clickhouse.conf if needed
527
+$ sudo vi /etc/netdata/python.d/clickhouse.conf
528
+
529
+# restart netdata
530
+# see docs for more information: https://learn.netdata.cloud/docs/configure/start-stop-restart
531
+$ sudo systemctl restart netdata
532
+```
533
+
534
+</details>
535
+<br>
536
+
537
- [CyberPower UPS](https://github.com/HawtDogFlvrWtr/netdata_cyberpwrups_plugin): Polls CyberPower UPS data using
538
PowerPanel® Personal Linux.
539
- [Logged-in users](https://github.com/veksh/netdata-numsessions): Collect the number of currently logged-on users.
@@ -509,6 +544,7 @@ default. To use a third-party collector, visit their GitHub/documentation page a
544
- [Teamspeak 3](https://github.com/coraxx/netdata_ts3_plugin): Pulls active users and bandwidth from TeamSpeak 3
545
servers.
546
- [SSH](https://github.com/Yaser-Amiri/netdata-ssh-module): Monitor failed authentication requests of an SSH server.
547
+- [ClickHouse](https://github.com/netdata/community/tree/main/collectors/python.d.plugin/clickhouse): Monitor [ClickHouse](https://clickhouse.com/) database.
548
549
## Etc
550