feat: add more telemetry

gno.land/cmd/gnoland/start.go

@@ -247,8 +247,10 @@
 	// Wrap the zap logger
 	logger := log.ZapLoggerToSlog(zapLogger)
 
-	// Initialize telemetry
-	telemetry.Init(*cfg.Telemetry)
+	// Initialize the telemetry
+	if err := telemetry.Init(*cfg.Telemetry); err != nil {
+		return fmt.Errorf("unable to initialize telemetry, %w", err)
+	}
 
 	// Write genesis file if missing.
 	// NOTE: this will be dropped in a PR that resolves issue #1886:

gno.land/pkg/sdk/vm/handler.go

@@ -1,12 +1,17 @@
 package vm
 
 import (
+	"context"
 	"fmt"
 	"strings"
 
 	abci "github.com/gnolang/gno/tm2/pkg/bft/abci/types"
 	"github.com/gnolang/gno/tm2/pkg/sdk"
 	"github.com/gnolang/gno/tm2/pkg/std"
+	"github.com/gnolang/gno/tm2/pkg/telemetry"
+	"github.com/gnolang/gno/tm2/pkg/telemetry/metrics"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/metric"
 )
 
 type vmHandler struct {
@@ -51,14 +56,6 @@
 	}
 	res.Data = []byte(resstr)
 	return
-	/* TODO handle events.
-	ctx.EventManager().EmitEvent(
-		sdk.NewEvent(
-			sdk.EventTypeMessage,
-			sdk.NewAttribute(sdk.AttributeKeyXXX, types.AttributeValueXXX),
-		),
-	)
-	*/
 }
 
 // Handle MsgRun.
@@ -71,7 +68,7 @@
 	return
 }
 
-//----------------------------------------
+// ----------------------------------------
 // Query
 
 // query paths
@@ -84,27 +81,58 @@
 	QueryFile    = "qfile"
 )
 
-func (vh vmHandler) Query(ctx sdk.Context, req abci.RequestQuery) (res abci.ResponseQuery) {
-	switch secondPart(req.Path) {
+func (vh vmHandler) Query(ctx sdk.Context, req abci.RequestQuery) abci.ResponseQuery {
+	var (
+		res  abci.ResponseQuery
+		path = secondPart(req.Path)
+	)
+
+	switch path {
 	case QueryPackage:
-		return vh.queryPackage(ctx, req)
+		res = vh.queryPackage(ctx, req)
 	case QueryStore:
-		return vh.queryStore(ctx, req)
+		res = vh.queryStore(ctx, req)
 	case QueryRender:
-		return vh.queryRender(ctx, req)
+		res = vh.queryRender(ctx, req)
 	case QueryFuncs:
-		return vh.queryFuncs(ctx, req)
+		res = vh.queryFuncs(ctx, req)
 	case QueryEval:
-		return vh.queryEval(ctx, req)
+		res = vh.queryEval(ctx, req)
 	case QueryFile:
-		return vh.queryFile(ctx, req)
+		res = vh.queryFile(ctx, req)
 	default:
-		res = sdk.ABCIResponseQueryFromError(
+		return sdk.ABCIResponseQueryFromError(
 			std.ErrUnknownRequest(fmt.Sprintf(
 				"unknown vm query endpoint %s in %s",
 				secondPart(req.Path), req.Path)))
+	}
+
+	// Log the telemetry
+	logQueryTelemetry(path, res.IsErr())
+
+	return res
+}
+
+// logQueryTelemetry logs the relevant VM query telemetry
+func logQueryTelemetry(path string, isErr bool) {
+	if !telemetry.MetricsEnabled() {
 		return
 	}
+
+	metrics.VMQueryCalls.Add(
+		context.Background(),
+		1,
+		metric.WithAttributes(
+			attribute.KeyValue{
+				Key:   "path",
+				Value: attribute.StringValue(path),
+			},
+		),
+	)
+
+	if isErr {
+		metrics.VMQueryErrors.Add(context.Background(), 1)
+	}
 }
 
 // queryPackage fetch a package's files.
@@ -187,7 +215,7 @@
 	return
 }
 
-//----------------------------------------
+// ----------------------------------------
 // misc
 
 func abciResult(err error) sdk.Result {

gno.land/pkg/sdk/vm/keeper.go

@@ -4,6 +4,7 @@
 
 import (
 	"bytes"
+	"context"
 	"fmt"
 	"os"
 	"regexp"
@@ -17,6 +18,10 @@
 	"github.com/gnolang/gno/tm2/pkg/sdk/bank"
 	"github.com/gnolang/gno/tm2/pkg/std"
 	"github.com/gnolang/gno/tm2/pkg/store"
+	"github.com/gnolang/gno/tm2/pkg/telemetry"
+	"github.com/gnolang/gno/tm2/pkg/telemetry/metrics"
+	"go.opentelemetry.io/otel/attribute"
+	"go.opentelemetry.io/otel/metric"
 )
 
 const (
@@ -218,6 +223,14 @@
 		}
 	}()
 	m2.RunMemPackage(memPkg, true)
+
+	// Log the telemetry
+	logTelemetry(
+		"m_addpkg",
+		m2.GasMeter.GasConsumed(),
+		m2.Cycles,
+	)
+
 	return nil
 }
 
@@ -315,7 +328,16 @@
 			res += "\n"
 		}
 	}
+
+	// Log the telemetry
+	logTelemetry(
+		"m_call",
+		m.GasMeter.GasConsumed(),
+		m.Cycles,
+	)
+
 	res += "\n\n" // use `\n\n` as separator to separate results for single tx with multi msgs
+
 	return res, nil
 	// TODO pay for gas? TODO see context?
 }
@@ -421,6 +443,14 @@
 	}()
 	m2.RunMain()
 	res = buf.String()
+
+	// Log the telemetry
+	logTelemetry(
+		"m_run",
+		m2.GasMeter.GasConsumed(),
+		m2.Cycles,
+	)
+
 	return res, nil
 }
 
@@ -639,3 +669,32 @@
 		return res, nil
 	}
 }
+
+// logTelemetry logs the VM processing telemetry
+func logTelemetry(
+	call string,
+	gasUsed int64,
+	cpuCycles int64,
+) {
+	if !telemetry.MetricsEnabled() {
+		return
+	}
+
+	// Record the operation frequency
+	metrics.VMExecMsgFrequency.Add(
+		context.Background(),
+		1,
+		metric.WithAttributes(
+			attribute.KeyValue{
+				Key:   "operation",
+				Value: attribute.StringValue(call),
+			},
+		),
+	)
+
+	// Record the CPU cycles
+	metrics.VMCPUCycles.Record(context.Background(), cpuCycles)
+
+	// Record the gas used
+	metrics.VMGasUsed.Record(context.Background(), gasUsed)
+}

misc/telemetry/Makefile

@@ -0,0 +1,11 @@
+.PHONY: up
+up:
+	docker compose up -d --build
+
+.PHONY: down
+down:
+	docker compose down
+
+.PHONY: clean
+clean:
+	docker compose down -v

misc/telemetry/README.md

@@ -0,0 +1,56 @@
+## Overview
+
+The purpose of this Telemetry documentation is to showcase the different node metrics exposed by the Gno node through
+OpenTelemetry, without having to do extraneous setup.
+
+The containerized setup is the following:
+
+- Grafana dashboard
+- Prometheus
+- OpenTelemetry collector (separate service that needs to run)
+- Single Gnoland node, with 1s block times and configured telemetry (enabled)
+- Supernova process that simulates load periodically (generates network traffic)
+
+## Starting the containers
+
+### Step 1: Spinning up Docker
+
+Make sure you have Docker installed and running on your system. After that, within the `misc/telemetry` folder run the
+following command:
+
+```shell
+make up
+```
+
+This will build out the required Docker images for this simulation, and start the services
+
+### Step 2: Open Grafana
+
+When you've verified that the `telemetry` containers are up and running, head on over to http://localhost:3000 to open
+the Grafana dashboard.
+
+Default login details:
+
+```
+username: admin
+password: admin
+```
+
+After you've logged in (you can skip setting a new password), on the left hand side, click on
+`Dashboards -> Gno -> Gno Node Metrics`:
+![Grafana](assets/grafana-1.jpeg)
+
+This will open up the predefined Gno Metrics dashboards (added for ease of use) :
+![Metrics Dashboard](assets/grafana-2.jpeg)
+
+Periodically, these metrics will be updated as the `supernova` process is simulating network traffic.
+
+### Step 3: Stopping the cluster
+
+To stop the cluster, you can run:
+
+```shell
+make down
+```
+
+which will stop the Docker containers. Additionally, you can delete the Docker volumes with `make clean`.

misc/telemetry/collector/collector.yaml

@@ -0,0 +1,22 @@
+receivers:
+  otlp:
+    protocols:
+      grpc:
+        endpoint: 0.0.0.0:4317
+
+processors:
+  batch:
+
+exporters:
+  prometheus:
+    endpoint: collector:8090
+
+service:
+  telemetry:
+    logs:
+      level: "debug"
+  pipelines:
+    metrics:
+      receivers: [ otlp ]
+      processors: [ batch ]
+      exporters: [ prometheus ]

misc/telemetry/docker-compose.yml

@@ -0,0 +1,65 @@
+services:
+  collector:
+    image: otel/opentelemetry-collector-contrib:latest
+    ports:
+      - "4317:4317"
+      - "4318:4318"
+      - "8090"
+    volumes:
+      - ./collector/collector.yaml:/etc/otelcol-contrib/config.yaml
+    networks:
+      - gnoland-net
+  prometheus:
+    image: prom/prometheus:latest
+    command:
+      - "--enable-feature=remote-write-receiver"
+      - "--config.file=/etc/prometheus/prometheus.yml"
+    ports:
+      - "9090:9090"
+    volumes:
+      - prometheus:/prometheus
+      - ./prometheus/prometheus.yml:/etc/prometheus/prometheus.yml
+    networks:
+      - gnoland-net
+  grafana:
+    image: grafana/grafana-enterprise
+    volumes:
+      - grafana_data:/var/lib/grafana
+      - ./grafana/datasources.yaml:/etc/grafana/provisioning/datasources/datasources.yaml
+      - ./grafana/dashboards.yaml:/etc/grafana/provisioning/dashboards/dashboards.yaml
+      - ./grafana/gno-dashboards.json:/var/lib/grafana/dashboards/gno-dashboards.json
+    ports:
+      - "3000:3000"
+    networks:
+      - gnoland-net
+  gnoland:
+    build:
+      context: ./gnoland
+      dockerfile: Dockerfile
+    ports:
+      - "26657:26657"
+    networks:
+      - gnoland-net
+  supernova:
+    build:
+      dockerfile: supernova.Dockerfile
+      args:
+        supernova_version: v1.2.1
+    command: >
+      -sub-accounts 10 -transactions 200 -url http://gnoland:26657
+      -mnemonic "source bonus chronic canvas draft south burst lottery vacant surface solve popular case indicate oppose farm nothing bullet exhibit title speed wink action roast"
+    restart: always
+    networks:
+      - gnoland-net
+
+networks:
+  gnoland-net:
+    driver: bridge
+
+volumes:
+  prometheus:
+    driver: local
+  grafana_data:
+    driver: local
+  gnoland:
+    driver: local