Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Add metrics to pubsub and peers #1226

Merged
merged 3 commits into from
Jul 17, 2024
Merged

feat: Add metrics to pubsub and peers #1226

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
95f880a
Add metrics to pubsub
kentquirk Jul 16, 2024
2865f6a
Fix some tests
kentquirk Jul 17, 2024
371ce06
more test fixes
kentquirk Jul 17, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion app/app_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ func newStartedApp(

var err error
if peers == nil {
peers = &peer.FilePeers{Cfg: c}
peers = &peer.FilePeers{Cfg: c, Metrics: &metrics.NullMetrics{}}
}

a := App{}
Expand Down
10 changes: 8 additions & 2 deletions internal/peer/file.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,13 @@
package peer

import "github.com/honeycombio/refinery/config"
import (
"github.com/honeycombio/refinery/config"
"github.com/honeycombio/refinery/metrics"
)

type FilePeers struct {
Cfg config.Config `inject:""`
Cfg config.Config `inject:""`
Metrics metrics.Metrics `inject:"metrics"`
}

func (p *FilePeers) GetPeers() ([]string, error) {
Expand All @@ -14,6 +18,7 @@ func (p *FilePeers) GetPeers() ([]string, error) {
if len(peers) == 0 {
peers = []string{"http://127.0.0.1:8081"}
}
p.Metrics.Gauge("num_file_peers", float64(len(peers)))
return peers, err
}

Expand All @@ -24,6 +29,7 @@ func (p *FilePeers) RegisterUpdatedPeersCallback(callback func()) {
}

func (p *FilePeers) Start() error {
p.Metrics.Register("num_file_peers", "gauge")
return nil
}

Expand Down
2 changes: 2 additions & 0 deletions internal/peer/peers_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/facebookgo/startstop"
"github.com/honeycombio/refinery/config"
"github.com/honeycombio/refinery/logger"
"github.com/honeycombio/refinery/metrics"
"github.com/honeycombio/refinery/pubsub"
"github.com/jonboulle/clockwork"
"github.com/sirupsen/logrus"
Expand Down Expand Up @@ -57,6 +58,7 @@ func newPeers(c config.Config) (Peers, error) {
{Value: c},
{Value: peers},
{Value: pubsubber},
{Value: &metrics.NullMetrics{}, Name: "metrics"},
{Value: &logger.NullLogger{}},
{Value: clockwork.NewFakeClock()},
}
Expand Down
15 changes: 12 additions & 3 deletions internal/peer/pubsub_redis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@ import (
"github.com/dgryski/go-wyhash"
"github.com/honeycombio/refinery/config"
"github.com/honeycombio/refinery/generics"
"github.com/honeycombio/refinery/metrics"
"github.com/honeycombio/refinery/pubsub"
"github.com/jonboulle/clockwork"
"github.com/sirupsen/logrus"
Expand Down Expand Up @@ -72,9 +73,10 @@ func (p *peerCommand) marshal() string {
}

type RedisPubsubPeers struct {
Config config.Config `inject:""`
PubSub pubsub.PubSub `inject:""`
Clock clockwork.Clock `inject:""`
Config config.Config `inject:""`
Metrics metrics.Metrics `inject:"metrics"`
PubSub pubsub.PubSub `inject:""`
Clock clockwork.Clock `inject:""`

peers *generics.SetWithTTL[string]
hash uint64
Expand All @@ -93,13 +95,16 @@ func (p *RedisPubsubPeers) checkHash() {
go cb()
}
}
p.Metrics.Gauge("num_peers", float64(len(peers)))
p.Metrics.Gauge("peer_hash", float64(p.hash))
}

func (p *RedisPubsubPeers) listen(msg string) {
cmd := &peerCommand{}
if !cmd.unmarshal(msg) {
return
}
p.Metrics.Count("peer_messages", 1)
switch cmd.action {
case Unregister:
p.peers.Remove(cmd.peer)
Expand All @@ -119,6 +124,10 @@ func (p *RedisPubsubPeers) Start() error {
p.callbacks = make([]func(), 0)
p.sub = p.PubSub.Subscribe(context.Background(), "peers", p.listen)

p.Metrics.Register("num_peers", "gauge")
p.Metrics.Register("peer_hash", "gauge")
p.Metrics.Register("peer_messages", "counter")

myaddr, err := publicAddr(p.Config)
if err != nil {
return err
Expand Down
17 changes: 12 additions & 5 deletions pubsub/pubsub_goredis.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (

"github.com/honeycombio/refinery/config"
"github.com/honeycombio/refinery/logger"
"github.com/honeycombio/refinery/metrics"
"github.com/redis/go-redis/v9"
)

Expand All @@ -21,11 +22,12 @@ import (
// GoRedisPubSub is a PubSub implementation that uses Redis as the message broker
// and the go-redis library to interact with Redis.
type GoRedisPubSub struct {
Config config.Config `inject:""`
Logger logger.Logger `inject:""`
client redis.UniversalClient
subs []*GoRedisSubscription
mut sync.RWMutex
Config config.Config `inject:""`
Logger logger.Logger `inject:""`
Metrics metrics.Metrics `inject:"metrics"`
client redis.UniversalClient
subs []*GoRedisSubscription
mut sync.RWMutex
}

// Ensure that GoRedisPubSub implements PubSub
Expand All @@ -46,6 +48,9 @@ func (ps *GoRedisPubSub) Start() error {
options := &redis.UniversalOptions{}
authcode := ""

ps.Metrics.Register("redis_pubsub_published", "counter")
ps.Metrics.Register("redis_pubsub_received", "counter")

if ps.Config != nil {
host, err := ps.Config.GetRedisHost()
if err != nil {
Expand Down Expand Up @@ -106,6 +111,7 @@ func (ps *GoRedisPubSub) Close() {
}

func (ps *GoRedisPubSub) Publish(ctx context.Context, topic, message string) error {
ps.Metrics.Count("redis_pubsub_published", 1)
return ps.client.Publish(ctx, topic, message).Err()
}

Expand Down Expand Up @@ -133,6 +139,7 @@ func (ps *GoRedisPubSub) Subscribe(ctx context.Context, topic string, callback f
if msg == nil {
continue
}
ps.Metrics.Count("redis_pubsub_received", 1)
go sub.cb(msg.Payload)
}
}
Expand Down
12 changes: 9 additions & 3 deletions pubsub/pubsub_local.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,17 @@ import (
"sync"

"github.com/honeycombio/refinery/config"
"github.com/honeycombio/refinery/metrics"
)

// LocalPubSub is a PubSub implementation that uses local channels to send messages; it does
// not communicate with any external processes.
// subs are individual channels for each subscription
type LocalPubSub struct {
Config config.Config `inject:""`
topics map[string][]*LocalSubscription
mut sync.RWMutex
Config config.Config `inject:""`
Metrics metrics.Metrics `inject:"metrics"`
topics map[string][]*LocalSubscription
mut sync.RWMutex
}

// Ensure that LocalPubSub implements PubSub
Expand All @@ -32,6 +34,8 @@ var _ Subscription = (*LocalSubscription)(nil)
// Start initializes the LocalPubSub
func (ps *LocalPubSub) Start() error {
ps.topics = make(map[string][]*LocalSubscription)
ps.Metrics.Register("local_pubsub_published", "counter")
ps.Metrics.Register("local_pubsub_received", "counter")
return nil
}

Expand Down Expand Up @@ -62,6 +66,8 @@ func (ps *LocalPubSub) Publish(ctx context.Context, topic, message string) error
ps.mut.Lock()
defer ps.mut.Unlock()
ps.ensureTopic(topic)
ps.Metrics.Count("local_pubsub_published", 1)
ps.Metrics.Count("local_pubsub_received", len(ps.topics[topic]))
for _, sub := range ps.topics[topic] {
// don't wait around for slow consumers
if sub.cb != nil {
Expand Down
11 changes: 9 additions & 2 deletions pubsub/pubsub_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"testing"
"time"

"github.com/honeycombio/refinery/metrics"
"github.com/honeycombio/refinery/pubsub"
"github.com/stretchr/testify/assert"
"github.com/stretchr/testify/require"
Expand All @@ -20,11 +21,17 @@ var types = []string{

func newPubSub(typ string) pubsub.PubSub {
var ps pubsub.PubSub
m := &metrics.NullMetrics{}
m.Start()
switch typ {
case "goredis":
ps = &pubsub.GoRedisPubSub{}
ps = &pubsub.GoRedisPubSub{
Metrics: m,
}
case "local":
ps = &pubsub.LocalPubSub{}
ps = &pubsub.LocalPubSub{
Metrics: m,
}
default:
panic("unknown pubsub type")
}
Expand Down
15 changes: 8 additions & 7 deletions sharder/deterministic_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ import (
"github.com/honeycombio/refinery/config"
"github.com/honeycombio/refinery/internal/peer"
"github.com/honeycombio/refinery/logger"
"github.com/honeycombio/refinery/metrics"
"github.com/stretchr/testify/assert"
)

Expand All @@ -29,7 +30,7 @@ func TestWhichShard(t *testing.T) {
}
done := make(chan struct{})
defer close(done)
filePeers := &peer.FilePeers{Cfg: config}
filePeers := &peer.FilePeers{Cfg: config, Metrics: &metrics.NullMetrics{}}
sharder := DeterministicSharder{
Config: config,
Logger: &logger.NullLogger{},
Expand Down Expand Up @@ -71,7 +72,7 @@ func TestWhichShardAtEdge(t *testing.T) {
}
done := make(chan struct{})
defer close(done)
filePeers := &peer.FilePeers{Cfg: config}
filePeers := &peer.FilePeers{Cfg: config, Metrics: &metrics.NullMetrics{}}
sharder := DeterministicSharder{
Config: config,
Logger: &logger.NullLogger{},
Expand Down Expand Up @@ -122,7 +123,7 @@ func BenchmarkShardBulk(b *testing.B) {
}
done := make(chan struct{})
defer close(done)
filePeers := &peer.FilePeers{Cfg: config}
filePeers := &peer.FilePeers{Cfg: config, Metrics: &metrics.NullMetrics{}}
sharder := DeterministicSharder{
Config: config,
Logger: &logger.NullLogger{},
Expand Down Expand Up @@ -168,7 +169,7 @@ func TestShardBulk(t *testing.T) {
}
done := make(chan struct{})
defer close(done)
filePeers := &peer.FilePeers{Cfg: config}
filePeers := &peer.FilePeers{Cfg: config, Metrics: &metrics.NullMetrics{}}
sharder := DeterministicSharder{
Config: config,
Logger: &logger.NullLogger{},
Expand Down Expand Up @@ -240,7 +241,7 @@ func TestShardDrop(t *testing.T) {
}
done := make(chan struct{})
defer close(done)
filePeers := &peer.FilePeers{Cfg: config}
filePeers := &peer.FilePeers{Cfg: config, Metrics: &metrics.NullMetrics{}}
sharder := DeterministicSharder{
Config: config,
Logger: &logger.NullLogger{},
Expand Down Expand Up @@ -323,7 +324,7 @@ func TestShardAddHash(t *testing.T) {
}
done := make(chan struct{})
defer close(done)
filePeers := &peer.FilePeers{Cfg: config}
filePeers := &peer.FilePeers{Cfg: config, Metrics: &metrics.NullMetrics{}}
sharder := DeterministicSharder{
Config: config,
Logger: &logger.NullLogger{},
Expand Down Expand Up @@ -404,7 +405,7 @@ func BenchmarkDeterministicShard(b *testing.B) {
}
done := make(chan struct{})
defer close(done)
filePeers := &peer.FilePeers{Cfg: config}
filePeers := &peer.FilePeers{Cfg: config, Metrics: &metrics.NullMetrics{}}
sharder := DeterministicSharder{
Config: config,
Logger: &logger.NullLogger{},
Expand Down
Loading