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

Jump to bottom

chore(sync)!: Rename unrecentHead to outdatedHead in metrics + clean up Head func a bit #163

Merged
merged 2 commits into from
Mar 14, 2024
Merged

chore(sync)!: Rename unrecentHead to outdatedHead in metrics + clean up Head func a bit #163

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ce20115
chore(sync)!: Rename `unrecentHead` to `outdatedHead` in metrics + cl…
renaynay Mar 7, 2024
e8c4c5c
fix(sync): report metrics only on acquisition of lock, add comment
renaynay Mar 11, 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
14 changes: 7 additions & 7 deletions sync/metrics.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ type metrics struct {

syncLoopStarted metric.Int64Counter
trustedPeersOutOfSync metric.Int64Counter
unrecentHeader metric.Int64Counter
outdatedHeader metric.Int64Counter
subjectiveInit metric.Int64Counter

subjectiveHead atomic.Int64
Expand Down Expand Up @@ -53,9 +53,9 @@ func newMetrics() (*metrics, error) {
return nil, err
}

unrecentHeader, err := meter.Int64Counter(
"hdr_sync_unrecent_header_counter",
metric.WithDescription("tracks every time Syncer returns an unrecent header"),
outdatedHeader, err := meter.Int64Counter(
"hdr_sync_outdated_head_counter",
Wondertan marked this conversation as resolved.
Show resolved Hide resolved
metric.WithDescription("tracks every time Syncer returns an outdated head"),
)
if err != nil {
return nil, err
Expand Down Expand Up @@ -110,7 +110,7 @@ func newMetrics() (*metrics, error) {
m := &metrics{
syncLoopStarted: syncLoopStarted,
trustedPeersOutOfSync: trustedPeersOutOfSync,
unrecentHeader: unrecentHeader,
outdatedHeader: outdatedHeader,
subjectiveInit: subjectiveInit,
syncLoopDurationHist: syncLoopDurationHist,
syncLoopRunningInst: syncLoopRunningInst,
Expand Down Expand Up @@ -148,9 +148,9 @@ func (m *metrics) syncFinished(ctx context.Context) {
})
}

func (m *metrics) unrecentHead(ctx context.Context) {
func (m *metrics) outdatedHead(ctx context.Context) {
m.observe(ctx, func(ctx context.Context) {
m.unrecentHeader.Add(ctx, 1)
m.outdatedHeader.Add(ctx, 1)
})
}

Expand Down
16 changes: 8 additions & 8 deletions sync/sync_head.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ import (
"github.com/celestiaorg/go-header"
)

var headRequestTimeout = time.Second * 2
Wondertan marked this conversation as resolved.
Show resolved Hide resolved

// Head returns the Network Head.
//
// Known subjective head is considered network head if it is recent enough(now-timestamp<=blocktime)
Expand All @@ -25,26 +27,24 @@ func (s *Syncer[H]) Head(ctx context.Context, _ ...header.HeadOption[H]) (H, err
return sbjHead, nil
}
// otherwise, request head from the network
// TODO: Besides requesting we should listen for new gossiped headers and cancel request if so
//
// single-flight protection
// ensure only one Head is requested at the time
s.metrics.outdatedHead(s.ctx)
Wondertan marked this conversation as resolved.
Show resolved Hide resolved

// single-flight protection ensure only one Head is requested at the time
if !s.getter.Lock() {
// means that other routine held the lock and set the subjective head for us,
// so just recursively get it
return s.Head(ctx)
}
defer s.getter.Unlock()
// limit time to get a recent header
// if we can't get it - give what we have
reqCtx, cancel := context.WithTimeout(ctx, time.Second*2) // TODO(@vgonkivs): make timeout configurable

reqCtx, cancel := context.WithTimeout(ctx, headRequestTimeout)
defer cancel()
s.metrics.unrecentHead(s.ctx)
netHead, err := s.getter.Head(reqCtx, header.WithTrustedHead[H](sbjHead))
if err != nil {
log.Warnw("failed to get recent head, returning current subjective", "sbjHead", sbjHead.Height(), "err", err)
return s.subjectiveHead(ctx)
}

// process and validate netHead fetched from trusted peers
// NOTE: We could trust the netHead like we do during 'automatic subjective initialization'
// but in this case our subjective head is not expired, so we should verify netHead
Expand Down
Loading