Suggest PRs to go to the community project (#14724)
Update python-collector.md
Chris Akritidis committed
Mar 17, 2023 at 07:17 UTC
58d2e333595b0fc96a75fbd465f63c3f62a0064a
1 file changed
+7
-13
docs/guides/python-collector.md
+7
-13
@@ -1,16 +1,3 @@
1
-<!--
2
-title: "Develop a custom data collector in Python"
3
-sidebar_label: "Develop a custom data collector in Python"
4
-description: "Learn how write a custom data collector in Python, which you'll use to collect metrics from and monitor any application that isn't supported out of the box."
5
-image: /img/seo/guides/python-collector.png
6
-author: "Panagiotis Papaioannou"
7
-author_title: "University of Patras"
8
-author_img: "/img/authors/panagiotis-papaioannou.jpg"
9
-custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/guides/python-collector.md
10
-learn_status: "Published"
11
-learn_rel_path: "Developers/External plugins/python.d.plugin"
12
--->
13
-
1
# Develop a custom data collector in Python
2
3
The Netdata Agent uses [data collectors](https://github.com/netdata/netdata/blob/master/collectors/README.md) to
@@ -22,11 +9,16 @@ In this tutorial, you'll learn how to leverage the [Python programming language]
9
custom data collector for the Netdata Agent. Follow along with your own dataset, using the techniques and best practices
10
covered here, or use the included examples for collecting and organizing either random or weather data.
11
12
+## Disclaimer
13
+
14
If you're comfortable with Golang, consider instead writing a module for the [go.d.plugin](https://github.com/netdata/go.d.plugin).
15
Golang is more performant, easier to maintain, and simpler for users since it doesn't require a particular runtime on the node to
16
execute. Python plugins require Python on the machine to be executed. Netdata uses Go as the platform of choice for
17
production-grade collectors.
18
19
+We generally do not accept contributions of Python modules to the Github project netdata/netdata. If you write a Python collector and
20
+want to make it available for other users, you should create the pull request in https://github.com/netdata/community.
21
+
22
## What you need to get started
23
24
- A physical or virtual Linux system, which we'll call a _node_.
@@ -535,6 +527,8 @@ You can find the source code for the above examples on [GitHub](https://github.c
527
528
## Pull Request Checklist for Python Plugins
529
530
+Pull requests should be created in https://github.com/netdata/community.
531
+
532
This is a generic checklist for submitting a new Python plugin for Netdata. It is by no means comprehensive.
533
534
At minimum, to be buildable and testable, the PR needs to include: