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.

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

cmd/soroban-rpc/internal/events: Fix eventsDurationMetric #119

Merged
merged 1 commit into from
Mar 29, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
27 changes: 16 additions & 11 deletions cmd/soroban-rpc/internal/events/events.go
Original file line number Diff line number Diff line change
Expand Up @@ -99,18 +99,25 @@ type ScanFunction func(xdr.DiagnosticEvent, Cursor, int64, *xdr.Hash) bool
// remaining events in the range). Note that a read lock is held for the
// entire duration of the Scan function so f should be written in a way
// to minimize latency.
func (m *MemoryStore) Scan(eventRange Range, f ScanFunction) (uint32, error) {
func (m *MemoryStore) Scan(eventRange Range, f ScanFunction) (lastLedgerInWindow uint32, err error) {
startTime := time.Now()
defer func() {
if err == nil {
m.eventsDurationMetric.With(prometheus.Labels{"operation": "scan"}).
Observe(time.Since(startTime).Seconds())
}
}()

m.lock.RLock()
defer m.lock.RUnlock()

if err := m.validateRange(&eventRange); err != nil {
return 0, err
if err = m.validateRange(&eventRange); err != nil {
return
}

firstLedgerInRange := eventRange.Start.Ledger
firstLedgerInWindow := m.eventsByLedger.Get(0).LedgerSeq
lastLedgerInWindow := firstLedgerInWindow + (m.eventsByLedger.Len() - 1)
lastLedgerInWindow = firstLedgerInWindow + (m.eventsByLedger.Len() - 1)
for i := firstLedgerInRange - firstLedgerInWindow; i < m.eventsByLedger.Len(); i++ {
bucket := m.eventsByLedger.Get(i)
events := bucket.BucketContent
Expand All @@ -122,21 +129,19 @@ func (m *MemoryStore) Scan(eventRange Range, f ScanFunction) (uint32, error) {
for _, event := range events {
cur := event.cursor(bucket.LedgerSeq)
if eventRange.End.Cmp(cur) <= 0 {
return lastLedgerInWindow, nil
return
}
var diagnosticEvent xdr.DiagnosticEvent
err := xdr.SafeUnmarshal(event.diagnosticEventXDR, &diagnosticEvent)
err = xdr.SafeUnmarshal(event.diagnosticEventXDR, &diagnosticEvent)
if err != nil {
return 0, err
return
}
if !f(diagnosticEvent, cur, timestamp, event.txHash) {
return lastLedgerInWindow, nil
return
}
}
}
m.eventsDurationMetric.With(prometheus.Labels{"operation": "scan"}).
Observe(time.Since(startTime).Seconds())
return lastLedgerInWindow, nil
return
}

// validateRange checks if the range falls within the bounds
Expand Down
20 changes: 18 additions & 2 deletions cmd/soroban-rpc/internal/events/events_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,8 @@ import (
"bytes"
"testing"

"github.com/prometheus/client_golang/prometheus"
dto "github.com/prometheus/client_model/go"
"github.com/stellar/go/xdr"
"github.com/stretchr/testify/require"

Expand Down Expand Up @@ -240,9 +242,16 @@ func concat(slices ...[]event) []event {
return result
}

func TestScan(t *testing.T) {
m := createStore(t)
func getMetricValue(metric prometheus.Metric) *dto.Metric {
value := &dto.Metric{}
err := metric.Write(value)
if err != nil {
panic(err)
}
return value
}

func TestScan(t *testing.T) {
genEquivalentInputs := func(input Range) []Range {
results := []Range{input}
if !input.ClampStart {
Expand Down Expand Up @@ -360,6 +369,7 @@ func TestScan(t *testing.T) {
},
} {
for _, input := range genEquivalentInputs(testCase.input) {
m := createStore(t)
var events []event
iterateAll := true
f := func(contractEvent xdr.DiagnosticEvent, cursor Cursor, ledgerCloseTimestamp int64, hash *xdr.Hash) bool {
Expand All @@ -378,11 +388,17 @@ func TestScan(t *testing.T) {
require.NoError(t, err)
require.Equal(t, uint32(8), latest)
eventsAreEqual(t, testCase.expected, events)
metric, err := m.eventsDurationMetric.MetricVec.GetMetricWith(prometheus.Labels{
"operation": "scan",
})
require.NoError(t, err)
require.Equal(t, uint64(1), getMetricValue(metric).GetSummary().GetSampleCount())
if len(events) > 0 {
events = nil
iterateAll = false
latest, err := m.Scan(input, f)
require.NoError(t, err)
require.Equal(t, uint64(2), getMetricValue(metric).GetSummary().GetSampleCount())
require.Equal(t, uint32(8), latest)
eventsAreEqual(t, []event{testCase.expected[0]}, events)
}
Expand Down
Loading