feat!: change time metrics (#55)

* feat!: change time metrics

* chore: fix linting

* chore: add readme on building from source

README.md

@@ -27,10 +27,19 @@ After that, you should unzip it, and you are ready to go:
 
 ```sh
 wget <the link from the releases page>
-tar xvfz <the filename you've just downloaded>
+tar <the filename you've just downloaded>
 ./cosmos-node-exporter <params>
 ```
 
+Alternatively, install `golang` (>1.18), clone the repo and build it:
+```
+git clone https://github.com/QuokkaStake/cosmos-node-exporter
+cd cosmos-node-exporter
+# This will generate a `cosmos-node-exporter` binary file in the repository folder
+make build
+# This will generate a `missed-blocks-checker` binary file in $GOPATH/bin
+```
+
 To run it in detached mode in background, first, we have to copy the file to the system apps folder:
 
 ```sh

assets/cosmovisor/upgrades/v15/fs_test.go

@@ -0,0 +1,12 @@
+package v15
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEmpty(t *testing.T) {
+	t.Parallel()
+	assert.True(t, true)
+}

pkg/clients/tendermint/tendermint.go

@@ -142,7 +142,7 @@ func (t *RPC) GetUpgradePlan(ctx context.Context) (*upgradeTypes.Plan, query_inf
 	return response.Plan, upgradePlanQuery, nil
 }
 
-func (t *RPC) GetEstimateTimeTillBlock(ctx context.Context, height int64) (time.Time, query_info.QueryInfo, error) {
+func (t *RPC) GetEstimateBlockTime(ctx context.Context, height int64) (time.Time, query_info.QueryInfo, error) {
 	childCtx, span := t.Tracer.Start(
 		ctx,
 		"Fetching estimate time till block",
@@ -183,5 +183,5 @@ func (t *RPC) GetEstimateTimeTillBlock(ctx context.Context, height int64) (time.
 	secondsTillEstimatedBlock := int64(float64(blocksTillEstimatedBlock) * blockTime)
 	durationTillEstimatedBlock := time.Duration(secondsTillEstimatedBlock * int64(time.Second))
 
-	return time.Now().Add(durationTillEstimatedBlock), upgradeTimeQuery, nil
+	return latestBlock.Result.Block.Header.Time.Add(durationTillEstimatedBlock), upgradeTimeQuery, nil
 }

pkg/clients/tendermint/tendermint_test.go

@@ -160,7 +160,7 @@ func TestTendermintTimeSinceLatestBlockFailCurrent(t *testing.T) {
 	tracer := tracing.InitNoopTracer()
 	rpc := NewRPC(config, *logger, tracer)
 
-	_, queryInfo, err := rpc.GetEstimateTimeTillBlock(context.Background(), 21078108)
+	_, queryInfo, err := rpc.GetEstimateBlockTime(context.Background(), 21078108)
 	require.Error(t, err)
 	assert.False(t, queryInfo.Success)
 	require.ErrorContains(t, err, "custom error")
@@ -191,7 +191,7 @@ func TestTendermintTimeSinceLatestBlockFailOlder(t *testing.T) {
 	tracer := tracing.InitNoopTracer()
 	rpc := NewRPC(config, *logger, tracer)
 
-	_, queryInfo, err := rpc.GetEstimateTimeTillBlock(context.Background(), 21078108)
+	_, queryInfo, err := rpc.GetEstimateBlockTime(context.Background(), 21078108)
 	require.Error(t, err)
 	assert.False(t, queryInfo.Success)
 	require.ErrorContains(t, err, "custom error")
@@ -222,11 +222,10 @@ func TestTendermintTimeSinceLatestBlockSuccess(t *testing.T) {
 	tracer := tracing.InitNoopTracer()
 	rpc := NewRPC(config, *logger, tracer)
 
-	currentTime := time.Now()
-	timeTillBlock, queryInfo, err := rpc.GetEstimateTimeTillBlock(context.Background(), 21078108)
+	timeTillBlock, queryInfo, err := rpc.GetEstimateBlockTime(context.Background(), 21078108)
 	require.NoError(t, err)
 	require.True(t, queryInfo.Success)
-	assert.Equal(t, "1h41m29s", timeTillBlock.Sub(currentTime).Round(time.Second).String())
+	assert.Equal(t, "2024-06-29T19:21:21Z", timeTillBlock.UTC().Format(time.RFC3339))
 }
 
 //nolint:paralleltest // disabled due to httpmock usage

pkg/constants/constants_test.go

@@ -0,0 +1,12 @@
+package constants
+
+import (
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+func TestEmpty(t *testing.T) {
+	t.Parallel()
+	assert.True(t, true)
+}

pkg/metrics/manager.go

@@ -30,10 +30,10 @@ func NewManager() *Manager {
 			[]string{"node"},
 		),
 
-		MetricNameTimeSinceLatestBlock: prometheus.NewGaugeVec(
+		MetricNameLatestBlockTime: prometheus.NewGaugeVec(
 			prometheus.GaugeOpts{
-				Name: constants.MetricsPrefix + "time_since_latest_block",
-				Help: "Time since latest block, in seconds",
+				Name: constants.MetricsPrefix + "latest_block_time",
+				Help: "Unix timestamp of the time of the latest block",
 			},
 			[]string{"node"},
 		),

pkg/metrics/types.go

@@ -5,7 +5,7 @@ type MetricName string
 const (
 	MetricNameCosmovisorVersion     MetricName = "cosmovisor_version"
 	MetricNameCatchingUp            MetricName = "catching_up"
-	MetricNameTimeSinceLatestBlock  MetricName = "time_since_latest_block"
+	MetricNameLatestBlockTime       MetricName = "latest_block_time"
 	MetricNameNodeInfo              MetricName = "node_info"
 	MetricNameTendermintVersion     MetricName = "tendermint_version"
 	MetricNameVotingPower           MetricName = "voting_power"

pkg/queriers/node_stats/querier.go

@@ -6,7 +6,6 @@ import (
 	"main/pkg/metrics"
 	"main/pkg/query_info"
 	"main/pkg/utils"
-	"time"
 
 	"go.opentelemetry.io/otel/attribute"
 	"go.opentelemetry.io/otel/trace"
@@ -57,9 +56,9 @@ func (n *Querier) Get(ctx context.Context) ([]metrics.MetricInfo, []query_info.Q
 			Value:      utils.BoolToFloat64(status.Result.SyncInfo.CatchingUp),
 		},
 		{
-			MetricName: metrics.MetricNameTimeSinceLatestBlock,
+			MetricName: metrics.MetricNameLatestBlockTime,
 			Labels:     map[string]string{},
-			Value:      time.Since(status.Result.SyncInfo.LatestBlockTime).Seconds(),
+			Value:      float64(status.Result.SyncInfo.LatestBlockTime.Unix()),
 		},
 		{
 			MetricName: metrics.MetricNameNodeInfo,

pkg/queriers/upgrades/querier.go

@@ -86,7 +86,7 @@ func (u *Querier) Get(ctx context.Context) ([]metrics.MetricInfo, []query_info.Q
 	})
 
 	// Calculate upgrade estimated time
-	upgradeTime, upgradeTimeQuery, err := u.Tendermint.GetEstimateTimeTillBlock(childCtx, upgrade.Height)
+	upgradeTime, upgradeTimeQuery, err := u.Tendermint.GetEstimateBlockTime(childCtx, upgrade.Height)
 	queryInfos = append(queryInfos, upgradeTimeQuery)
 
 	if err != nil {

pkg/queriers/upgrades/querier_test.go

@@ -304,6 +304,7 @@ func TestUpgradesQuerierTendermintCosmovisorOk(t *testing.T) {
 	upgradeTime := metrics[3]
 	assert.NotEmpty(t, upgradeTime.Labels["info"])
 	assert.Equal(t, "v1.5.0", upgradeTime.Labels["name"])
+	assert.InDelta(t, 1642330177, upgradeTime.Value, 0.01)
 
 	upgradePresent := metrics[4]
 	assert.NotEmpty(t, upgradePresent.Labels["info"])