Skip to content
This repository has been archived by the owner on Mar 27, 2024. It is now read-only.

Commit

Permalink
changes on broken links (#1478)
Browse files Browse the repository at this point in the history
  • Loading branch information
Ancairon authored Feb 8, 2024
1 parent 3408909 commit 0036acb
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/how-to-write-a-module.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ The steps are:
developed collector. It will be placed into the `bin` directory (e.g `go.d.plugin/bin`)
- Run it in the debug mode `bin/godplugin -d -m <MODULE_NAME>`. This will output the `STDOUT` of the collector, the same
output that is sent to the Netdata Agent and is transformed into charts. You can read more about this collector API in
our [documentation](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#external-plugins-api).
our [documentation](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md#external-plugins-api).
- If you want to test the collector with the actual Netdata Agent, you need to replace the `go.d.plugin` binary that
exists in the Netdata Agent installation directory with the one you just compiled. Once
you [restart](https://github.com/netdata/netdata/blob/master/docs/configure/start-stop-restart.md) the Netdata Agent, it will detect and run
Expand Down Expand Up @@ -116,13 +116,13 @@ func (e *Example) Check() bool {

### Charts method

:exclamation: Netdata module produces [`charts`](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#chart), not
:exclamation: Netdata module produces [`charts`](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md#chart), not
raw metrics.

Use [`agent/module`](https://github.com/netdata/go.d.plugin/blob/master/agent/module/charts.go) package to create them,
it contains charts and dimensions structs.

- `Charts` returns the [charts](https://github.com/netdata/netdata/blob/master/collectors/plugins.d/README.md#chart) (`*module.Charts`).
- `Charts` returns the [charts](https://github.com/netdata/netdata/blob/master/src/collectors/plugins.d/README.md#chart) (`*module.Charts`).
- Called after `Check` and only if `Check` returned `true`.
- If it returns `nil`, the job will be disabled
- :warning: Make sure not to share returned value between module instances (jobs).
Expand Down

0 comments on commit 0036acb

Please sign in to comment.