forked from atlassian/gostatsd
-
Notifications
You must be signed in to change notification settings - Fork 0
/
types.go
37 lines (30 loc) · 1.24 KB
/
types.go
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
package types
import (
"context"
"github.com/atlassian/gostatsd/types"
"github.com/spf13/viper"
)
// Factory is a function that returns a Backend.
type Factory func(*viper.Viper) (Backend, error)
// SendCallback is called by Backend.SendMetricsAsync() to notify about the result of operation.
// A list of errors is passed to the callback. It may be empty or contain nil values. Every non-nil value is an error
// that happened while sending metrics.
type SendCallback func([]error)
// Backend represents a backend.
type Backend interface {
// BackendName returns the name of the backend.
BackendName() string
// SampleConfig returns the sample config for the backend.
SampleConfig() string
// SendMetricsAsync flushes the metrics to the backend, preparing payload synchronously but doing the send asynchronously.
// Must not read/write MetricMap asynchronously.
SendMetricsAsync(context.Context, *types.MetricMap, SendCallback)
// SendEvent sends event to the backend.
SendEvent(context.Context, *types.Event) error
}
// RunnableBackend represents a backend that needs a Run method to be executed to work.
type RunnableBackend interface {
Backend
// Run executes backend send operations. Should be started in a goroutine.
Run(context.Context) error
}