diff options
Diffstat (limited to 'collectors/node.d.plugin/README.md')
| -rw-r--r-- | collectors/node.d.plugin/README.md | 12 |
1 files changed, 8 insertions, 4 deletions
diff --git a/collectors/node.d.plugin/README.md b/collectors/node.d.plugin/README.md index 6d7c1f871..8db80d85b 100644 --- a/collectors/node.d.plugin/README.md +++ b/collectors/node.d.plugin/README.md @@ -1,3 +1,8 @@ +<!-- +title: "node.d.plugin" +custom_edit_url: https://github.com/netdata/netdata/edit/master/collectors/node.d.plugin/README.md +--> + # node.d.plugin `node.d.plugin` is a Netdata external plugin. It is an **orchestrator** for data collection modules written in `node.js`. @@ -33,19 +38,18 @@ collectors in node.js. It also manages all its data collectors (placed in `/usr/ instance of node, thus lowering the memory footprint of data collection. Of course, there can be independent plugins written in node.js (placed in `/usr/libexec/netdata/plugins`). -These will have to be developed using the guidelines of **[External Plugins](../plugins.d/)**. +These will have to be developed using the guidelines of **[External Plugins](/collectors/plugins.d/README.md)**. To run `node.js` plugins you need to have `node` installed in your system. In some older systems, the package named `node` is not node.js. It is a terminal emulation program called `ax25-node`. In this case the node.js package may be referred as `nodejs`. Once you install `nodejs`, we suggest to link `/usr/bin/nodejs` to `/usr/bin/node`, so that typing `node` in your terminal, opens node.js. -For more information check the **\[[Installation]]** guide. ## configuring `node.d.plugin` `node.d.plugin` can work even without any configuration. Its default configuration file is -[/etc/netdata/node.d.conf](node.d.conf) (to edit it on your system run `/etc/netdata/edit-config node.d.conf`). +`node.d.conf`. To edit it on your system, run `/etc/netdata/edit-config node.d.conf`. ## configuring `node.d.plugin` modules @@ -227,6 +231,6 @@ The `service` object defines a set of functions to allow you send information to --- _FIXME: document an operational node.d.plugin data collector - the best example is the -[snmp collector](snmp/snmp.node.js)_ +[snmp collector](https://raw.githubusercontent.com/netdata/netdata/master/collectors/node.d.plugin/snmp/snmp.node.js)_ [](<>) |