client.go

package metrics

import (
	"github.com/prometheus/client_golang/prometheus"
)

type ClientConfig struct {
	MessageInflightTimeBuckets   []float64
	ReceivedMessageSizeBuckets   []float64
	SentMessageSizeBuckets       []float64
	MessageProcessingTimeBuckets []float64
	SendSyncResponseTimeBuckets  []float64
	SendTimeBuckets              []float64
}

func DefaultClientConfig() ClientConfig {
	return ClientConfig{
		MessageInflightTimeBuckets:   prometheus.DefBuckets,
		ReceivedMessageSizeBuckets:   defBucketsForSizeBytes,
		SentMessageSizeBuckets:       defBucketsForSizeBytes,
		MessageProcessingTimeBuckets: prometheus.DefBuckets,
		SendSyncResponseTimeBuckets:  prometheus.DefBuckets,
		SendTimeBuckets:              prometheus.DefBuckets,
	}
}

type ClientMetrics struct {
	MessageInflightTime         *prometheus.HistogramVec
	MessageReceivedSize         *prometheus.HistogramVec
	MessageSentSize             *prometheus.HistogramVec
	MessageProcessingTime       *prometheus.HistogramVec
	MessageSentSyncResponseTime *prometheus.HistogramVec
	MessageSentTime             *prometheus.HistogramVec
	CurrentStatus               prometheus.Gauge
	ConcurrentWorkers           prometheus.Gauge
	ConfigMaxConcurrency        prometheus.Gauge
	BroadcastCmdCount           *prometheus.CounterVec
	SubscribeCmdCount           *prometheus.CounterVec
	UnsubscribeCmdCount         *prometheus.CounterVec
	PublishCmdCount             *prometheus.CounterVec
	Errors                      prometheus.Counter
}

func NewClientMetrics(c ClientConfig) *ClientMetrics {
	return &ClientMetrics{

		MessageInflightTime: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "message_received_inflight_duration_seconds",
			Help:      "The time the message spent over the wire till received",
			Buckets:   c.MessageInflightTimeBuckets,
		}, []string{"kind"}),

		MessageReceivedSize: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "message_received_size_bytes",
			Help:      "The size of the received messages in bytes",
			Buckets:   c.ReceivedMessageSizeBuckets,
		}, []string{"kind"}),

		MessageSentSize: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "message_sent_size_bytes",
			Help:      "The size of the sent messages in bytes",
			Buckets:   c.SentMessageSizeBuckets,
		}, []string{"kind"}),

		MessageSentTime: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "message_sent_duration_seconds",
			Help:      "The time spent in during asynchronous message sending operation (buffer)",
			Buckets:   c.SendTimeBuckets,
		}, []string{"kind"}),

		MessageProcessingTime: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "message_processing_duration_seconds",
			Help:      "The time spent in message handler execution",
			Buckets:   c.MessageProcessingTimeBuckets,
		}, []string{"kind"}),

		MessageSentSyncResponseTime: prometheus.NewHistogramVec(prometheus.HistogramOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "message_sent_sync_duration_seconds",
			Help:      "The time spent in a synchronous message sending operation",
			Buckets:   c.SendSyncResponseTimeBuckets,
		}, []string{"kind"}),

		CurrentStatus: prometheus.NewGauge(prometheus.GaugeOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "status",
			Help:      "The current status of the client (0 => New, 1 => Running, 2=> Closing, 3 => closed)",
		}),

		ConcurrentWorkers: prometheus.NewGauge(prometheus.GaugeOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "concurrent_workers",
			Help:      "The current number of running workers in the client",
		}),

		ConfigMaxConcurrency: prometheus.NewGauge(prometheus.GaugeOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "config_max_concurrency",
			Help:      "The configured maximum number of parallel workers in the client",
		}),

		BroadcastCmdCount: prometheus.NewCounterVec(prometheus.CounterOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "broadcast_cmd_sent_total",
			Help:      "The number of broadcast commands sent by the client to the server.",
		}, []string{"message"}),

		SubscribeCmdCount: prometheus.NewCounterVec(prometheus.CounterOpts{
			Namespace: "goomerang",
			Subsystem: "client_pubsub",
			Name:      "subscribe_cmd_sent_total",
			Help:      "The number of subscribe commands sent by the client to the server.",
		}, []string{"topic"}),

		PublishCmdCount: prometheus.NewCounterVec(prometheus.CounterOpts{
			Namespace: "goomerang",
			Subsystem: "client_pubsub",
			Name:      "publish_cmd_sent_total",
			Help:      "The number of publish commands sent by the client to the server.",
		}, []string{"topic", "message"}),

		UnsubscribeCmdCount: prometheus.NewCounterVec(prometheus.CounterOpts{
			Namespace: "goomerang",
			Subsystem: "client_pubsub",
			Name:      "unsubscribe_cmd_sent_total",
			Help:      "The number of unsubscribe commands sent by the client to the server.",
		}, []string{"topic"}),

		Errors: prometheus.NewCounter(prometheus.CounterOpts{
			Namespace: "goomerang",
			Subsystem: "client",
			Name:      "errors_total",
			Help:      "The errors happened in client",
		}),
	}
}

func (m *ClientMetrics) Register(r prometheus.Registerer) {
	r.MustRegister(m.MessageInflightTime)
	r.MustRegister(m.MessageReceivedSize)
	r.MustRegister(m.MessageSentSize)
	r.MustRegister(m.MessageSentTime)
	r.MustRegister(m.MessageProcessingTime)
	r.MustRegister(m.MessageSentSyncResponseTime)
	r.MustRegister(m.CurrentStatus)
	r.MustRegister(m.ConcurrentWorkers)
	r.MustRegister(m.ConfigMaxConcurrency)
	r.MustRegister(m.BroadcastCmdCount)
	r.MustRegister(m.SubscribeCmdCount)
	r.MustRegister(m.PublishCmdCount)
	r.MustRegister(m.UnsubscribeCmdCount)
	r.MustRegister(m.Errors)
}