1 files changed, 109 insertions, 0 deletions
diff --git a/src/go/collectors/go.d.plugin/modules/example/example.go b/src/go/collectors/go.d.plugin/modules/example/example.go
new file mode 100644
index 000000000..2b1da8a51
--- /dev/null
+++ b/src/go/collectors/go.d.plugin/modules/example/example.go
@@ -0,0 +1,109 @@
+// SPDX-License-Identifier: GPL-3.0-or-later
+
+package example
+
+import (
+	_ "embed"
+	"math/rand"
+
+	"github.com/netdata/netdata/go/go.d.plugin/agent/module"
+)
+
+//go:embed "config_schema.json"
+var configSchema string
+
+func init() {
+	module.Register("example", module.Creator{
+		JobConfigSchema: configSchema,
+		Defaults: module.Defaults{
+			UpdateEvery: module.UpdateEvery,
+			Priority:    module.Priority,
+			Disabled:    true,
+		},
+		Create: func() module.Module { return New() },
+	})
+}
+
+func New() *Example {
+	return &Example{
+		Config: Config{
+			Charts: ConfigCharts{
+				Num:  1,
+				Dims: 4,
+			},
+			HiddenCharts: ConfigCharts{
+				Num:  0,
+				Dims: 4,
+			},
+		},
+
+		randInt:       func() int64 { return rand.Int63n(100) },
+		collectedDims: make(map[string]bool),
+	}
+}
+
+type (
+	Config struct {
+		UpdateEvery  int          `yaml:"update_every" json:"update_every"`
+		Charts       ConfigCharts `yaml:"charts" json:"charts"`
+		HiddenCharts ConfigCharts `yaml:"hidden_charts" json:"hidden_charts"`
+	}
+	ConfigCharts struct {
+		Type     string `yaml:"type" json:"type"`
+		Num      int    `yaml:"num" json:"num"`
+		Contexts int    `yaml:"contexts" json:"contexts"`
+		Dims     int    `yaml:"dimensions" json:"dimensions"`
+		Labels   int    `yaml:"labels" json:"labels"`
+	}
+)
+
+type Example struct {
+	module.Base // should be embedded by every module
+	Config      `yaml:",inline"`
+
+	randInt       func() int64
+	charts        *module.Charts
+	collectedDims map[string]bool
+}
+
+func (e *Example) Configuration() any {
+	return e.Config
+}
+
+func (e *Example) Init() error {
+	err := e.validateConfig()
+	if err != nil {
+		e.Errorf("config validation: %v", err)
+		return err
+	}
+
+	charts, err := e.initCharts()
+	if err != nil {
+		e.Errorf("charts init: %v", err)
+		return err
+	}
+	e.charts = charts
+	return nil
+}
+
+func (e *Example) Check() error {
+	return nil
+}
+
+func (e *Example) Charts() *module.Charts {
+	return e.charts
+}
+
+func (e *Example) Collect() map[string]int64 {
+	mx, err := e.collect()
+	if err != nil {
+		e.Error(err)
+	}
+
+	if len(mx) == 0 {
+		return nil
+	}
+	return mx
+}
+
+func (e *Example) Cleanup() {}