aboutsummaryrefslogtreecommitdiffstats
path: root/library/go/core/metrics/solomon/registry_opts.go
blob: 5a68a3928316fb4c2386b50a30411e6f6eb14c13 (plain) (blame)
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
package solomon

import (
	"context"

	"github.com/ydb-platform/ydb/library/go/core/metrics"
	"github.com/ydb-platform/ydb/library/go/core/metrics/collect"
	"github.com/ydb-platform/ydb/library/go/core/metrics/internal/pkg/registryutil"
)

type RegistryOpts struct {
	Separator    rune
	Prefix       string
	Tags         map[string]string
	Rated        bool
	UseNameTag   bool
	Collectors   []func(metrics.Registry)
	StreamFormat StreamFormat
}

// NewRegistryOpts returns new initialized instance of RegistryOpts
func NewRegistryOpts() *RegistryOpts {
	return &RegistryOpts{
		Separator:    '.',
		Tags:         make(map[string]string),
		UseNameTag:   false,
		StreamFormat: StreamSpack,
	}
}

// SetUseNameTag overrides current UseNameTag opt
func (o *RegistryOpts) SetUseNameTag(useNameTag bool) *RegistryOpts {
	o.UseNameTag = useNameTag
	return o
}

// SetTags overrides existing tags
func (o *RegistryOpts) SetTags(tags map[string]string) *RegistryOpts {
	o.Tags = tags
	return o
}

// AddTags merges given tags with existing
func (o *RegistryOpts) AddTags(tags map[string]string) *RegistryOpts {
	for k, v := range tags {
		o.Tags[k] = v
	}
	return o
}

// SetPrefix overrides existing prefix
func (o *RegistryOpts) SetPrefix(prefix string) *RegistryOpts {
	o.Prefix = prefix
	return o
}

// AppendPrefix adds given prefix as postfix to existing using separator
func (o *RegistryOpts) AppendPrefix(prefix string) *RegistryOpts {
	o.Prefix = registryutil.BuildFQName(string(o.Separator), o.Prefix, prefix)
	return o
}

// SetSeparator overrides existing separator
func (o *RegistryOpts) SetSeparator(separator rune) *RegistryOpts {
	o.Separator = separator
	return o
}

// SetRated overrides existing rated flag
func (o *RegistryOpts) SetRated(rated bool) *RegistryOpts {
	o.Rated = rated
	return o
}

// AddCollectors adds collectors that handle their metrics automatically (e.g. system metrics).
func (o *RegistryOpts) AddCollectors(
	ctx context.Context, c metrics.CollectPolicy, collectors ...collect.Func,
) *RegistryOpts {
	if len(collectors) == 0 {
		return o
	}

	o.Collectors = append(o.Collectors, func(r metrics.Registry) {
		for _, collector := range collectors {
			collector(ctx, r, c)
		}
	})
	return o
}

// SetStreamFormat sets default sensors stream format
func (o *RegistryOpts) SetStreamFormat(format StreamFormat) *RegistryOpts {
	o.StreamFormat = format
	return o
}