[#426] Put prometheus behind pkg/metrics

Signed-off-by: Alex Vanin <alexey@nspcc.ru>
This commit is contained in:
Alex Vanin 2021-03-16 11:14:56 +03:00 committed by Leonard Lyubich
parent 3c0e47e6fd
commit b8e10571c6
19 changed files with 561 additions and 311 deletions

View file

@ -38,8 +38,8 @@ func (r *ListContainersRes) Containers() []*container.ID {
// ContainerSize returns sum of estimation container sizes among all shards.
func (e *StorageEngine) ContainerSize(prm *ContainerSizePrm) *ContainerSizeRes {
if e.enableMetrics {
defer elapsed(estimateContainerSizeDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddEstimateContainerSizeDuration)()
}
return &ContainerSizeRes{
@ -74,8 +74,8 @@ func (e *StorageEngine) containerSize(id *container.ID) (total uint64) {
// ListContainers returns unique container IDs presented in the engine objects.
func (e *StorageEngine) ListContainers(_ *ListContainersPrm) *ListContainersRes {
if e.enableMetrics {
defer elapsed(listContainersDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddListContainersDuration)()
}
return &ListContainersRes{

View file

@ -30,10 +30,6 @@ func (e *StorageEngine) Init() error {
}
}
if e.enableMetrics {
registerMetrics()
}
return nil
}

View file

@ -27,8 +27,8 @@ func (p *DeletePrm) WithAddresses(addr ...*objectSDK.Address) *DeletePrm {
// Delete marks the objects to be removed.
func (e *StorageEngine) Delete(prm *DeletePrm) (*DeleteRes, error) {
if e.enableMetrics {
defer elapsed(deleteDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddDeleteDuration)()
}
shPrm := new(shard.InhumePrm)

View file

@ -23,7 +23,7 @@ type Option func(*cfg)
type cfg struct {
log *logger.Logger
enableMetrics bool
metrics MetricRegister
}
func defaultCfg() *cfg {
@ -54,8 +54,8 @@ func WithLogger(l *logger.Logger) Option {
}
}
func WithMetrics(v bool) Option {
func WithMetrics(v MetricRegister) Option {
return func(c *cfg) {
c.enableMetrics = v
c.metrics = v
}
}

View file

@ -38,8 +38,8 @@ func (p *ExistsRes) Exists() bool {
// Returns any error encountered that does not allow to
// unambiguously determine the presence of an object.
func (e *StorageEngine) Exists(prm *ExistsPrm) (*ExistsRes, error) {
if e.enableMetrics {
defer elapsed(existsDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddExistsDuration)()
}
exists, err := e.exists(prm.addr)

View file

@ -42,8 +42,8 @@ func (r *GetRes) Object() *object.Object {
//
// Returns ErrNotFound if requested object is missing in local storage.
func (e *StorageEngine) Get(prm *GetPrm) (*GetRes, error) {
if e.enableMetrics {
defer elapsed(getDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddGetDuration)()
}
var (

View file

@ -56,8 +56,8 @@ func (r *HeadRes) Header() *object.Object {
// Returns object.ErrNotFound if requested object is missing in local storage.
// Returns object.ErrAlreadyRemoved if requested object was inhumed.
func (e *StorageEngine) Head(prm *HeadPrm) (*HeadRes, error) {
if e.enableMetrics {
defer elapsed(headDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddHeadDuration)()
}
var (

View file

@ -49,8 +49,8 @@ var errInhumeFailure = errors.New("inhume operation failed")
// Inhume calls metabase. Inhume method to mark object as removed. It won't be
// removed physically from shard until `Delete` operation.
func (e *StorageEngine) Inhume(prm *InhumePrm) (*InhumeRes, error) {
if e.enableMetrics {
defer elapsed(inhumeDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddInhumeDuration)()
}
shPrm := new(shard.InhumePrm)

View file

@ -2,112 +2,26 @@ package engine
import (
"time"
"github.com/prometheus/client_golang/prometheus"
)
const (
namespace = "neofs_node"
subsystem = "engine"
)
var (
listContainersDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "list_containers_duration",
Help: "Accumulated duration of engine list containers operations",
})
estimateContainerSizeDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "estimate_container_size_duration",
Help: "Accumulated duration of engine container size estimate operations",
})
deleteDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "delete_duration",
Help: "Accumulated duration of engine delete operations",
})
existsDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "exists_duration",
Help: "Accumulated duration of engine exists operations",
})
getDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "get_duration",
Help: "Accumulated duration of engine get operations",
})
headDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "head_duration",
Help: "Accumulated duration of engine head operations",
})
inhumeDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "inhume_duration",
Help: "Accumulated duration of engine inhume operations",
})
putDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "put_duration",
Help: "Accumulated duration of engine put operations",
})
rangeDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "range_duration",
Help: "Accumulated duration of engine range operations",
})
searchDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "search_duration",
Help: "Accumulated duration of engine search operations",
})
listObjectsDuration = prometheus.NewCounter(prometheus.CounterOpts{
Namespace: namespace,
Subsystem: subsystem,
Name: "list_objects_duration",
Help: "Accumulated duration of engine list objects operations",
})
)
func registerMetrics() {
prometheus.MustRegister(listContainersDuration)
prometheus.MustRegister(estimateContainerSizeDuration)
prometheus.MustRegister(deleteDuration)
prometheus.MustRegister(existsDuration)
prometheus.MustRegister(getDuration)
prometheus.MustRegister(headDuration)
prometheus.MustRegister(inhumeDuration)
prometheus.MustRegister(putDuration)
prometheus.MustRegister(rangeDuration)
prometheus.MustRegister(searchDuration)
prometheus.MustRegister(listObjectsDuration)
type MetricRegister interface {
AddListContainersDuration(d time.Duration)
AddEstimateContainerSizeDuration(d time.Duration)
AddDeleteDuration(d time.Duration)
AddExistsDuration(d time.Duration)
AddGetDuration(d time.Duration)
AddHeadDuration(d time.Duration)
AddInhumeDuration(d time.Duration)
AddPutDuration(d time.Duration)
AddRangeDuration(d time.Duration)
AddSearchDuration(d time.Duration)
AddListObjectsDuration(d time.Duration)
}
func elapsed(c prometheus.Counter) func() {
func elapsed(addFunc func(d time.Duration)) func() {
t := time.Now()
return func() {
c.Add(float64(time.Since(t)))
addFunc(time.Since(t))
}
}

View file

@ -34,8 +34,8 @@ func (p *PutPrm) WithObject(obj *object.Object) *PutPrm {
// Returns any error encountered that
// did not allow to completely save the object.
func (e *StorageEngine) Put(prm *PutPrm) (*PutRes, error) {
if e.enableMetrics {
defer elapsed(putDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddPutDuration)()
}
_, err := e.exists(prm.obj.Address()) // todo: make this check parallel

View file

@ -60,8 +60,8 @@ func (r *RngRes) Object() *object.Object {
// Returns ErrAlreadyRemoved if requested object is inhumed.
// Returns ErrRangeOutOfBounds if requested object range is out of bounds.
func (e *StorageEngine) GetRange(prm *RngPrm) (*RngRes, error) {
if e.enableMetrics {
defer elapsed(rangeDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddRangeDuration)()
}
var (

View file

@ -48,8 +48,8 @@ func (r *SelectRes) AddressList() []*object.Address {
//
// Returns any error encountered that did not allow to completely select the objects.
func (e *StorageEngine) Select(prm *SelectPrm) (*SelectRes, error) {
if e.enableMetrics {
defer elapsed(searchDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddSearchDuration)()
}
addrList := make([]*object.Address, 0)
@ -98,8 +98,8 @@ func (e *StorageEngine) Select(prm *SelectPrm) (*SelectRes, error) {
// List returns `limit` available physically storage object addresses in engine.
// If limit is zero, then returns all available object addresses.
func (e *StorageEngine) List(limit uint64) (*SelectRes, error) {
if e.enableMetrics {
defer elapsed(listObjectsDuration)()
if e.metrics != nil {
defer elapsed(e.metrics.AddListObjectsDuration)()
}
addrList := make([]*object.Address, limit)