summaryrefslogtreecommitdiffstats
path: root/src/go/plugin/go.d/modules/dovecot/dovecot.go
blob: ee3d6239905d39a8c68d7bf828e1b4b5ca752d6a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
// SPDX-License-Identifier: GPL-3.0-or-later

package dovecot

import (
	_ "embed"
	"errors"
	"time"

	"github.com/netdata/netdata/go/plugins/plugin/go.d/agent/module"
	"github.com/netdata/netdata/go/plugins/plugin/go.d/pkg/web"
)

//go:embed "config_schema.json"
var configSchema string

func init() {
	module.Register("dovecot", module.Creator{
		JobConfigSchema: configSchema,
		Create:          func() module.Module { return New() },
		Config:          func() any { return &Config{} },
	})
}

func New() *Dovecot {
	return &Dovecot{
		Config: Config{
			Address: "127.0.0.1:24242",
			Timeout: web.Duration(time.Second * 1),
		},
		newConn: newDovecotConn,
		charts:  charts.Copy(),
	}
}

type Config struct {
	UpdateEvery int          `yaml:"update_every,omitempty" json:"update_every"`
	Address     string       `yaml:"address" json:"address"`
	Timeout     web.Duration `yaml:"timeout" json:"timeout"`
}

type Dovecot struct {
	module.Base
	Config `yaml:",inline" json:""`

	charts *module.Charts

	newConn func(Config) dovecotConn
	conn    dovecotConn
}

func (d *Dovecot) Configuration() any {
	return d.Config
}

func (d *Dovecot) Init() error {
	if d.Address == "" {
		d.Error("config: 'address' not set")
		return errors.New("address not set")
	}

	return nil
}

func (d *Dovecot) Check() error {
	mx, err := d.collect()
	if err != nil {
		d.Error(err)
		return err
	}

	if len(mx) == 0 {
		return errors.New("no metrics collected")
	}

	return nil
}

func (d *Dovecot) Charts() *module.Charts {
	return d.charts
}

func (d *Dovecot) Collect() map[string]int64 {
	mx, err := d.collect()
	if err != nil {
		d.Error(err)
	}

	if len(mx) == 0 {
		return nil
	}

	return mx
}

func (d *Dovecot) Cleanup() {
	if d.conn != nil {
		d.conn.disconnect()
		d.conn = nil
	}
}