docs: simplify go.d.plugin readme (#18949)
Ilya Mashchenko committed
Nov 6, 2024 at 11:55 UTC
0c4f36da26d185e4066046ca0b524c80df2d2a76
1 file changed
+15
-42
src/go/plugin/go.d/README.md
+15
-42
@@ -1,32 +1,18 @@
1
# go.d.plugin
2
3
-`go.d.plugin` is a [Netdata](https://github.com/netdata/netdata) external plugin. It is an **orchestrator** for data
4
-collection modules written in `go`.
3
+`go.d.plugin` is a [Netdata](https://github.com/netdata/netdata) external plugin:
4
6
-1. It runs as an independent process (`ps fax` shows it).
7
-2. It is started and stopped automatically by Netdata.
8
-3. It communicates with Netdata via a unidirectional pipe (sending data to the Netdata daemon).
9
-4. Supports any number of data collection modules.
10
-5. Allows each module to have any number of data collection jobs.
11
-
12
-## Bug reports, feature requests, and questions
13
-
14
-Are welcome! We are using [netdata/netdata](https://github.com/netdata/netdata/) repository for bugs, feature requests,
15
-and questions.
16
-
17
-- [GitHub Issues](https://github.com/netdata/netdata/issues/new/choose): report bugs or open a new feature request.
18
-- [GitHub Discussions](https://github.com/netdata/netdata/discussions): ask a question or suggest a new idea.
19
-
20
-## Install
21
-
22
-Go.d.plugin is shipped with Netdata.
5
+- **Independent Operation**: Runs as a separate process from Netdata core, visible in system process lists (`ps fax`).
6
+- **Automated Management**: Integrated with Netdata's lifecycle management, managed automatically by Netdata (start/stop operations).
7
+- **Efficient Communication**: Uses a unidirectional pipe for optimal data transfer to Netdata.
8
+- **Modular Architecture**:
9
+ - Supports an unlimited number of data collection modules.
10
+ - Each module can run multiple collection jobs simultaneously.
11
+ - Easy to extend with new collection modules
12
13
### Required Linux capabilities
14
26
-All capabilities are set automatically during Netdata installation using
27
-the [official installation method](/packaging/installer/methods/kickstart.md).
28
-No further action required. If you have used a different installation method and need to set the capabilities manually,
29
-see the appropriate collector readme.
15
+All capabilities are set automatically during Netdata installation using the [official installation method](/packaging/installer/methods/kickstart.md).
16
17
| Capability | Required by |
18
|:--------------------|:-------------------------------------------------------------------------------------------------------:|
@@ -36,6 +22,9 @@ see the appropriate collector readme.
22
23
## Available modules
24
25
+<details>
26
+<summary>Data Collection Modules</summary>
27
+
28
| Name | Monitors |
29
|:-------------------------------------------------------------------------------------------------------------------|:-----------------------------:|
30
| [adaptec_raid](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/adaptecraid) | Adaptec Hardware RAID |
@@ -159,6 +148,8 @@ see the appropriate collector readme.
148
| [zfspool](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/zfspool) | ZFS Pools |
149
| [zookeeper](https://github.com/netdata/netdata/tree/master/src/go/plugin/go.d/modules/zookeeper) | ZooKeeper |
150
151
+</details>
152
+
153
## Configuration
154
155
Edit the `go.d.conf` configuration file using `edit-config` from the
@@ -194,18 +185,7 @@ modules:
185
example: yes
186
```
187
197
-Then [restart netdata](/docs/netdata-agent/start-stop-restart.md)
198
-for the change to take effect.
199
-
200
-## Contributing
201
-
202
-If you want to contribute to this project, we are humbled. Please take a look at
203
-our [contributing guidelines](https://github.com/netdata/.github/blob/main/CONTRIBUTING.md) and don't hesitate to
204
-contact us in our forums.
205
-
206
-### How to develop a collector
207
-
208
-Read [how to write a Netdata collector in Go](/src/go/plugin/go.d/docs/how-to-write-a-module.md).
188
+Then [restart netdata](/docs/netdata-agent/start-stop-restart.md) for the change to take effect.
189
190
## Troubleshooting
191
@@ -237,10 +217,3 @@ sudo su -s /bin/bash netdata
217
```
218
219
Change `<module name>` to the [module name](#available-modules) you want to debug.
240
-
241
-## Netdata Community
242
-
243
-This repository follows the Netdata Code of Conduct and is part of the Netdata Community.
244
-
245
-- [Community Forums](https://community.netdata.cloud)
246
-- [Netdata Code of Conduct](https://github.com/netdata/.github/blob/main/CODE_OF_CONDUCT.md)