You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
180 lines
6.4 KiB
180 lines
6.4 KiB
package p2p
|
|
|
|
import (
|
|
"fmt"
|
|
"reflect"
|
|
"regexp"
|
|
"sync"
|
|
|
|
"github.com/go-kit/kit/metrics"
|
|
"github.com/go-kit/kit/metrics/discard"
|
|
"github.com/go-kit/kit/metrics/prometheus"
|
|
stdprometheus "github.com/prometheus/client_golang/prometheus"
|
|
)
|
|
|
|
const (
|
|
// MetricsSubsystem is a subsystem shared by all metrics exposed by this
|
|
// package.
|
|
MetricsSubsystem = "p2p"
|
|
)
|
|
|
|
var (
|
|
// valueToLabelRegexp is used to find the golang package name and type name
|
|
// so that the name can be turned into a prometheus label where the characters
|
|
// in the label do not include prometheus special characters such as '*' and '.'.
|
|
valueToLabelRegexp = regexp.MustCompile(`\*?(\w+)\.(.*)`)
|
|
)
|
|
|
|
// Metrics contains metrics exposed by this package.
|
|
type Metrics struct {
|
|
// Number of peers.
|
|
Peers metrics.Gauge
|
|
// Number of bytes received from a given peer.
|
|
PeerReceiveBytesTotal metrics.Counter
|
|
// Number of bytes sent to a given peer.
|
|
PeerSendBytesTotal metrics.Counter
|
|
// Pending bytes to be sent to a given peer.
|
|
PeerPendingSendBytes metrics.Gauge
|
|
|
|
// RouterPeerQueueRecv defines the time taken to read off of a peer's queue
|
|
// before sending on the connection.
|
|
RouterPeerQueueRecv metrics.Histogram
|
|
|
|
// RouterPeerQueueSend defines the time taken to send on a peer's queue which
|
|
// will later be read and sent on the connection (see RouterPeerQueueRecv).
|
|
RouterPeerQueueSend metrics.Histogram
|
|
|
|
// RouterChannelQueueSend defines the time taken to send on a p2p channel's
|
|
// queue which will later be consued by the corresponding reactor/service.
|
|
RouterChannelQueueSend metrics.Histogram
|
|
|
|
// PeerQueueDroppedMsgs defines the number of messages dropped from a peer's
|
|
// queue for a specific flow (i.e. Channel).
|
|
PeerQueueDroppedMsgs metrics.Counter
|
|
|
|
// PeerQueueMsgSize defines the average size of messages sent over a peer's
|
|
// queue for a specific flow (i.e. Channel).
|
|
PeerQueueMsgSize metrics.Gauge
|
|
|
|
mtx *sync.RWMutex
|
|
messageLabelNames map[reflect.Type]string
|
|
}
|
|
|
|
// PrometheusMetrics returns Metrics build using Prometheus client library.
|
|
// Optionally, labels can be provided along with their values ("foo",
|
|
// "fooValue").
|
|
//
|
|
// nolint: lll
|
|
func PrometheusMetrics(namespace string, labelsAndValues ...string) *Metrics {
|
|
labels := []string{}
|
|
for i := 0; i < len(labelsAndValues); i += 2 {
|
|
labels = append(labels, labelsAndValues[i])
|
|
}
|
|
return &Metrics{
|
|
Peers: prometheus.NewGaugeFrom(stdprometheus.GaugeOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "peers",
|
|
Help: "Number of peers.",
|
|
}, labels).With(labelsAndValues...),
|
|
|
|
PeerReceiveBytesTotal: prometheus.NewCounterFrom(stdprometheus.CounterOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "peer_receive_bytes_total",
|
|
Help: "Number of bytes received from a given peer.",
|
|
}, append(labels, "peer_id", "chID", "message_type")).With(labelsAndValues...),
|
|
|
|
PeerSendBytesTotal: prometheus.NewCounterFrom(stdprometheus.CounterOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "peer_send_bytes_total",
|
|
Help: "Number of bytes sent to a given peer.",
|
|
}, append(labels, "peer_id", "chID", "message_type")).With(labelsAndValues...),
|
|
|
|
PeerPendingSendBytes: prometheus.NewGaugeFrom(stdprometheus.GaugeOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "peer_pending_send_bytes",
|
|
Help: "Number of pending bytes to be sent to a given peer.",
|
|
}, append(labels, "peer_id")).With(labelsAndValues...),
|
|
|
|
RouterPeerQueueRecv: prometheus.NewHistogramFrom(stdprometheus.HistogramOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "router_peer_queue_recv",
|
|
Help: "The time taken to read off of a peer's queue before sending on the connection.",
|
|
}, labels).With(labelsAndValues...),
|
|
|
|
RouterPeerQueueSend: prometheus.NewHistogramFrom(stdprometheus.HistogramOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "router_peer_queue_send",
|
|
Help: "The time taken to send on a peer's queue which will later be read and sent on the connection (see RouterPeerQueueRecv).",
|
|
}, labels).With(labelsAndValues...),
|
|
|
|
RouterChannelQueueSend: prometheus.NewHistogramFrom(stdprometheus.HistogramOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "router_channel_queue_send",
|
|
Help: "The time taken to send on a p2p channel's queue which will later be consued by the corresponding reactor/service.",
|
|
}, labels).With(labelsAndValues...),
|
|
|
|
PeerQueueDroppedMsgs: prometheus.NewCounterFrom(stdprometheus.CounterOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "router_channel_queue_dropped_msgs",
|
|
Help: "The number of messages dropped from a peer's queue for a specific p2p Channel.",
|
|
}, append(labels, "ch_id")).With(labelsAndValues...),
|
|
|
|
PeerQueueMsgSize: prometheus.NewGaugeFrom(stdprometheus.GaugeOpts{
|
|
Namespace: namespace,
|
|
Subsystem: MetricsSubsystem,
|
|
Name: "router_channel_queue_msg_size",
|
|
Help: "The size of messages sent over a peer's queue for a specific p2p Channel.",
|
|
}, append(labels, "ch_id")).With(labelsAndValues...),
|
|
|
|
mtx: &sync.RWMutex{},
|
|
messageLabelNames: map[reflect.Type]string{},
|
|
}
|
|
}
|
|
|
|
// NopMetrics returns no-op Metrics.
|
|
func NopMetrics() *Metrics {
|
|
return &Metrics{
|
|
Peers: discard.NewGauge(),
|
|
PeerReceiveBytesTotal: discard.NewCounter(),
|
|
PeerSendBytesTotal: discard.NewCounter(),
|
|
PeerPendingSendBytes: discard.NewGauge(),
|
|
RouterPeerQueueRecv: discard.NewHistogram(),
|
|
RouterPeerQueueSend: discard.NewHistogram(),
|
|
RouterChannelQueueSend: discard.NewHistogram(),
|
|
PeerQueueDroppedMsgs: discard.NewCounter(),
|
|
PeerQueueMsgSize: discard.NewGauge(),
|
|
mtx: &sync.RWMutex{},
|
|
messageLabelNames: map[reflect.Type]string{},
|
|
}
|
|
}
|
|
|
|
// ValueToMetricLabel is a method that is used to produce a prometheus label value of the golang
|
|
// type that is passed in.
|
|
// This method uses a map on the Metrics struct so that each label name only needs
|
|
// to be produced once to prevent expensive string operations.
|
|
func (m *Metrics) ValueToMetricLabel(i interface{}) string {
|
|
t := reflect.TypeOf(i)
|
|
m.mtx.RLock()
|
|
|
|
if s, ok := m.messageLabelNames[t]; ok {
|
|
m.mtx.RUnlock()
|
|
return s
|
|
}
|
|
m.mtx.RUnlock()
|
|
|
|
s := t.String()
|
|
ss := valueToLabelRegexp.FindStringSubmatch(s)
|
|
l := fmt.Sprintf("%s_%s", ss[1], ss[2])
|
|
m.mtx.Lock()
|
|
defer m.mtx.Unlock()
|
|
m.messageLabelNames[t] = l
|
|
return l
|
|
}
|