example

README

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, which is typically at /etc/netdata.

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.

# go.d.conf
modules:
  example: yes

Here is an example configuration with several jobs:

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.

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].

  cd /usr/libexec/netdata/plugins.d/
  

• Switch to the netdata user.

  sudo -u netdata -s
  

• Run the go.d.plugin to debug the collector:

  ./go.d.plugin -d -m example
  

Documentation

Index

• type Config
• type ConfigCharts
• type Example
  • func New() *Example
  • func (e *Example) Charts() *module.Charts
  • func (e *Example) Check() bool
  • func (e *Example) Cleanup()
  • func (e *Example) Collect() map[string]int64
  • func (e *Example) Init() bool

Types

type Config

type Config struct {
	Charts       ConfigCharts `yaml:"charts"`
	HiddenCharts ConfigCharts `yaml:"hidden_charts"`
}

type ConfigCharts

type ConfigCharts struct {
	Type     string `yaml:"type"`
	Num      int    `yaml:"num"`
	Contexts int    `yaml:"contexts"`
	Dims     int    `yaml:"dimensions"`
	Labels   int    `yaml:"labels"`
}

type Example

type Example struct {
	module.Base // should be embedded by every module
	Config      `yaml:",inline"`
	// contains filtered or unexported fields
}

func New

func New() *Example

func (*Example) Charts

func (e *Example) Charts() *module.Charts

func (*Example) Check

func (e *Example) Check() bool

func (*Example) Cleanup

func (e *Example) Cleanup()

func (*Example) Collect

func (e *Example) Collect() map[string]int64

func (*Example) Init

func (e *Example) Init() bool