Skip to content

Commit

Permalink
use user context for metrics observation
Browse files Browse the repository at this point in the history
  • Loading branch information
walldiss committed May 9, 2023
1 parent 6bfcb8a commit 764de47
Show file tree
Hide file tree
Showing 2 changed files with 28 additions and 29 deletions.
22 changes: 11 additions & 11 deletions share/availability/discovery/discovery.go
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ func (d *Discovery) Advertise(ctx context.Context) {
defer timer.Stop()
for {
ttl, err := d.disc.Advertise(ctx, rendezvousPoint)
d.metrics.observeAdvertise(err)
d.metrics.observeAdvertise(ctx, err)
if err != nil {
log.Debugf("Error advertising %s: %s", rendezvousPoint, err.Error())
if ctx.Err() != nil {
Expand Down Expand Up @@ -286,16 +286,16 @@ func (d *Discovery) discover(ctx context.Context) bool {
drainChannel(ticker.C)
select {
case <-findCtx.Done():
d.metrics.observeFindPeers(true, true)
d.metrics.observeFindPeers(ctx, true, true)
return true
case <-ticker.C:
d.metrics.observeDiscoveryStuck()
d.metrics.observeDiscoveryStuck(ctx)
log.Warn("wasn't able to find new peers for long time")
continue
case p, ok := <-peers:
if !ok {
isEnoughPeers := d.set.Size() >= d.set.Limit()
d.metrics.observeFindPeers(ctx.Err() != nil, isEnoughPeers)
d.metrics.observeFindPeers(ctx, ctx.Err() != nil, isEnoughPeers)
log.Debugw("discovery channel closed", "find_is_canceled", findCtx.Err() != nil)
return isEnoughPeers
}
Expand Down Expand Up @@ -333,19 +333,19 @@ func (d *Discovery) handleDiscoveredPeer(ctx context.Context, peer peer.AddrInfo
logger := log.With("peer", peer.ID)
switch {
case peer.ID == d.host.ID():
d.metrics.observeHandlePeer(handlePeerSkipSelf)
d.metrics.observeHandlePeer(ctx, handlePeerSkipSelf)
logger.Debug("skip handle: self discovery")
return false
case len(peer.Addrs) == 0:
d.metrics.observeHandlePeer(handlePeerEmptyAddrs)
d.metrics.observeHandlePeer(ctx, handlePeerEmptyAddrs)
logger.Debug("skip handle: empty address list")
return false
case d.set.Size() >= d.set.Limit():
d.metrics.observeHandlePeer(handlePeerEnoughPeers)
d.metrics.observeHandlePeer(ctx, handlePeerEnoughPeers)
logger.Debug("skip handle: enough peers found")
return false
case d.connector.HasBackoff(peer.ID):
d.metrics.observeHandlePeer(handlePeerBackoff)
d.metrics.observeHandlePeer(ctx, handlePeerBackoff)
logger.Debug("skip handle: backoff")
return false
}
Expand All @@ -356,7 +356,7 @@ func (d *Discovery) handleDiscoveredPeer(ctx context.Context, peer peer.AddrInfo
case network.NotConnected:
err := d.connector.Connect(ctx, peer)
if err != nil {
d.metrics.observeHandlePeer(handlePeerConnErr)
d.metrics.observeHandlePeer(ctx, handlePeerConnErr)
logger.Debugw("unable to connect", "err", err)
return false
}
Expand All @@ -365,12 +365,12 @@ func (d *Discovery) handleDiscoveredPeer(ctx context.Context, peer peer.AddrInfo
}

if !d.set.Add(peer.ID) {
d.metrics.observeHandlePeer(handlePeerInSet)
d.metrics.observeHandlePeer(ctx, handlePeerInSet)
logger.Debug("peer is already in discovery set")
return false
}
d.onUpdatedPeers(peer.ID, true)
d.metrics.observeHandlePeer(handlePeerConnected)
d.metrics.observeHandlePeer(ctx, handlePeerConnected)
logger.Debug("added peer to set")

// tag to protect peer from being killed by ConnManager
Expand Down
35 changes: 17 additions & 18 deletions share/availability/discovery/metrics.go
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,6 @@ package discovery
import (
"context"
"fmt"
"time"

"github.com/libp2p/go-libp2p/core/peer"
"go.opentelemetry.io/otel/attribute"
"go.opentelemetry.io/otel/metric/global"
Expand All @@ -14,8 +12,6 @@ import (
)

const (
observeTimeout = 100 * time.Millisecond

discoveryEnougPeersKey = "enough_peers"
discoveryFindCancledKey = "is_canceled"

Expand Down Expand Up @@ -125,35 +121,38 @@ func initMetrics(d *Discovery) (*metrics, error) {
return metrics, nil
}

func (m *metrics) observeFindPeers(canceled, isEnoughPeers bool) {
func (m *metrics) observeFindPeers(ctx context.Context, canceled, isEnoughPeers bool) {
if m == nil {
return
}
ctx, cancel := context.WithTimeout(context.Background(), observeTimeout)
defer cancel()
if ctx.Err() != nil {
ctx = context.Background()
}

m.discoveryResult.Add(ctx, 1,
attribute.Bool(discoveryFindCancledKey, canceled),
attribute.Bool(discoveryEnougPeersKey, isEnoughPeers))
}

func (m *metrics) observeHandlePeer(result handlePeerResult) {
func (m *metrics) observeHandlePeer(ctx context.Context, result handlePeerResult) {
if m == nil {
return
}
ctx, cancel := context.WithTimeout(context.Background(), observeTimeout)
defer cancel()
if ctx.Err() != nil {
ctx = context.Background()
}

m.handlePeerResult.Add(ctx, 1,
attribute.String(handlePeerResultKey, string(result)))
}

func (m *metrics) observeAdvertise(err error) {
func (m *metrics) observeAdvertise(ctx context.Context, err error) {
if m == nil {
return
}
ctx, cancel := context.WithTimeout(context.Background(), observeTimeout)
defer cancel()
if ctx.Err() != nil {
ctx = context.Background()
}

m.advertise.Add(ctx, 1,
attribute.Bool(advertiseFailedKey, err != nil))
Expand All @@ -163,8 +162,7 @@ func (m *metrics) observeOnPeersUpdate(_ peer.ID, isAdded bool) {
if m == nil {
return
}
ctx, cancel := context.WithTimeout(context.Background(), observeTimeout)
defer cancel()
ctx := context.Background()

if isAdded {
m.peerAdded.Add(ctx, 1)
Expand All @@ -173,12 +171,13 @@ func (m *metrics) observeOnPeersUpdate(_ peer.ID, isAdded bool) {
m.peerRemoved.Add(ctx, 1)
}

func (m *metrics) observeDiscoveryStuck() {
func (m *metrics) observeDiscoveryStuck(ctx context.Context) {
if m == nil {
return
}
ctx, cancel := context.WithTimeout(context.Background(), observeTimeout)
defer cancel()
if ctx.Err() != nil {
ctx = context.Background()
}

m.discoveryStuck.Add(ctx, 1)
}

0 comments on commit 764de47

Please sign in to comment.