From 87d772a7d708fec12f48cd8adc0dedff6e1025da Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Mon, 26 Aug 2024 10:15:20 +0200 Subject: Adding upstream version 1.47.0. Signed-off-by: Daniel Baumann --- .../go.d.plugin/modules/example/README.md | 80 ---------------------- 1 file changed, 80 deletions(-) delete mode 100644 src/go/collectors/go.d.plugin/modules/example/README.md (limited to 'src/go/collectors/go.d.plugin/modules/example/README.md') diff --git a/src/go/collectors/go.d.plugin/modules/example/README.md b/src/go/collectors/go.d.plugin/modules/example/README.md deleted file mode 100644 index 01eb34eb5..000000000 --- a/src/go/collectors/go.d.plugin/modules/example/README.md +++ /dev/null @@ -1,80 +0,0 @@ - - -# Example module - -An example data collection module. Use it as an example writing a new module. - -## Charts - -This module produces example charts with random values. Number of charts, dimensions and chart type is configurable. - -## Configuration - -Edit the `go.d/example.conf` configuration file using `edit-config` from the -Netdata [config directory](/docs/netdata-agent/configuration/README.md), which is typically at `/etc/netdata`. - -```bash -cd /etc/netdata # Replace this path with your Netdata config directory -sudo ./edit-config go.d/example.conf -``` - -Disabled by default. Should be explicitly enabled -in [go.d.conf](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d.conf). - -```yaml -# go.d.conf -modules: - example: yes -``` - -Here is an example configuration with several jobs: - -```yaml -jobs: - - name: example - charts: - num: 3 - dimensions: 5 - - - name: hidden_example - hidden_charts: - num: 3 - dimensions: 5 -``` - ---- - -For all available options, see the Example -collector's [configuration file](https://github.com/netdata/netdata/blob/master/src/go/collectors/go.d.plugin/config/go.d/example.conf). - -## Troubleshooting - -To troubleshoot issues with the `example` collector, run the `go.d.plugin` with the debug option enabled. The output -should give you clues as to why the collector isn't working. - -- Navigate to the `plugins.d` directory, usually at `/usr/libexec/netdata/plugins.d/`. If that's not the case on - your system, open `netdata.conf` and look for the `plugins` setting under `[directories]`. - - ```bash - cd /usr/libexec/netdata/plugins.d/ - ``` - -- Switch to the `netdata` user. - - ```bash - sudo -u netdata -s - ``` - -- Run the `go.d.plugin` to debug the collector: - - ```bash - ./go.d.plugin -d -m example - ``` -- cgit v1.2.3