feat: add gas price to prometheus (#1257)

avilagaston9 · uri-99 · web-flow · commit 6097ff5e7dce · 2024-10-18T11:34:12.000-03:00
Co-authored-by: Uriel Mihura &lt;43704209+uri-99@users.noreply.github.com&gt;
diff --git a/grafana/provisioning/dashboards/aligned/ethereum.json b/grafana/provisioning/dashboards/aligned/ethereum.json
@@ -0,0 +1,146 @@
+{
+    "annotations": {
+        "list": [
+            {
+                "builtIn": 1,
+                "datasource": {
+                    "type": "grafana",
+                    "uid": "-- Grafana --"
+                },
+                "enable": true,
+                "hide": true,
+                "iconColor": "rgba(0, 211, 255, 1)",
+                "name": "Annotations & Alerts",
+                "type": "dashboard"
+            }
+        ]
+    },
+    "editable": true,
+    "fiscalYearStartMonth": 0,
+    "graphTooltip": 0,
+    "id": 4,
+    "links": [],
+    "liveNow": false,
+    "panels": [
+        {
+            "datasource": {
+                "type": "prometheus",
+                "uid": "prometheus"
+            },
+            "fieldConfig": {
+                "defaults": {
+                    "color": {
+                        "mode": "palette-classic"
+                    },
+                    "custom": {
+                        "axisCenteredZero": false,
+                        "axisColorMode": "text",
+                        "axisLabel": "gwei",
+                        "axisPlacement": "auto",
+                        "barAlignment": 0,
+                        "drawStyle": "line",
+                        "fillOpacity": 3,
+                        "gradientMode": "none",
+                        "hideFrom": {
+                            "legend": false,
+                            "tooltip": false,
+                            "viz": false
+                        },
+                        "insertNulls": false,
+                        "lineInterpolation": "linear",
+                        "lineStyle": {
+                            "fill": "solid"
+                        },
+                        "lineWidth": 3,
+                        "pointSize": 1,
+                        "scaleDistribution": {
+                            "type": "linear"
+                        },
+                        "showPoints": "auto",
+                        "spanNulls": false,
+                        "stacking": {
+                            "group": "A",
+                            "mode": "none"
+                        },
+                        "thresholdsStyle": {
+                            "mode": "off"
+                        }
+                    },
+                    "mappings": [],
+                    "thresholds": {
+                        "mode": "absolute",
+                        "steps": [
+                            {
+                                "color": "green",
+                                "value": null
+                            },
+                            {
+                                "color": "red",
+                                "value": 80
+                            }
+                        ]
+                    },
+                    "unit": "none"
+                },
+                "overrides": []
+            },
+            "gridPos": {
+                "h": 8,
+                "w": 12,
+                "x": 0,
+                "y": 0
+            },
+            "id": 1,
+            "options": {
+                "legend": {
+                    "calcs": [],
+                    "displayMode": "list",
+                    "placement": "bottom",
+                    "showLegend": false
+                },
+                "tooltip": {
+                    "mode": "single",
+                    "sort": "none"
+                }
+            },
+            "targets": [
+                {
+                    "datasource": {
+                        "type": "prometheus",
+                        "uid": "prometheus"
+                    },
+                    "disableTextWrap": false,
+                    "editorMode": "code",
+                    "expr": "gas_price * 10^(-9)",
+                    "fullMetaSearch": false,
+                    "hide": false,
+                    "includeNullMetadata": true,
+                    "instant": false,
+                    "legendFormat": "__auto",
+                    "range": true,
+                    "refId": "A",
+                    "useBackend": false
+                }
+            ],
+            "title": "Gas Price",
+            "type": "timeseries"
+        }
+    ],
+    "refresh": "",
+    "schemaVersion": 38,
+    "style": "dark",
+    "tags": [],
+    "templating": {
+        "list": []
+    },
+    "time": {
+        "from": "now-30m",
+        "to": "now"
+    },
+    "timepicker": {},
+    "timezone": "",
+    "title": "Ethereum",
+    "uid": "cc1ca6ab-6a36-41e0-afcf-2946c15afde5",
+    "version": 6,
+    "weekStart": ""
+}
diff --git a/prometheus/prometheus.yaml b/prometheus/prometheus.yaml
@@ -24,3 +24,10 @@ scrape_configs:
       - targets: [ "host.docker.internal:9093" ]
         labels:
           bot: "batcher"
+  
+  - job_name: "aligned-tracker"
+    scrape_interval: 1s
+    static_configs:
+      - targets: [ "host.docker.internal:4001" ]
+        labels:
+          bot: "tracker"
diff --git a/telemetry_api/.env.dev b/telemetry_api/.env.dev
@@ -1,3 +1,4 @@
-ALIGNED_CONFIG_FILE="../contracts/script/output/devnet/alignedlayer_deployment_output.json"
-OPERATOR_FETCHER_WAIT_TIME_MS=5000
-ENVIRONMENT=devnet
+export ALIGNED_CONFIG_FILE="../contracts/script/output/devnet/alignedlayer_deployment_output.json"
+export OPERATOR_FETCHER_WAIT_TIME_MS=5000
+export ENVIRONMENT=devnet
+export RPC_URL=http://localhost:8545
diff --git a/telemetry_api/config/dev.exs b/telemetry_api/config/dev.exs
@@ -63,8 +63,14 @@ config :phoenix, :stacktrace_depth, 20
 # Initialize plugs at runtime for faster development compilation
 config :phoenix, :plug_init_mode, :runtime
 
+# Node RPC URL
+rpc_url = System.get_env("RPC_URL") ||
+  raise """
+  environment variable RPC_URL is missing.
+  """
+  
 # Configure ethereumex url
-config :ethereumex, url: "http://localhost:8545"
+config :ethereumex, url: rpc_url
 
 # For development, we use the stdout exporter to ensure everything is working properly
 # config :opentelemetry, traces_exporter: {:otel_exporter_stdout, []}
diff --git a/telemetry_api/lib/telemetry_api/application.ex b/telemetry_api/lib/telemetry_api/application.ex
@@ -7,6 +7,8 @@ defmodule TelemetryApi.Application do
 
   @impl true
   def start(_type, _args) do
+    TelemetryApi.MetricsExporter.setup()
+
     children = [
       TraceStore,
       TelemetryApiWeb.Telemetry,
@@ -17,7 +19,7 @@ defmodule TelemetryApi.Application do
       # {TelemetryApi.Worker, arg},
       # Start to serve requests, typically the last entry
       TelemetryApiWeb.Endpoint,
-      TelemetryApi.Periodic.OperatorFetcher
+      TelemetryApi.Periodically
     ]
 
     # See https://hexdocs.pm/elixir/Supervisor.html
diff --git a/telemetry_api/lib/telemetry_api/contract_managers/operator_state_retriever.ex b/telemetry_api/lib/telemetry_api/contract_managers/operator_state_retriever.ex
@@ -46,6 +46,7 @@ defmodule TelemetryApi.ContractManagers.OperatorStateRetriever do
       parse_operators(operators_state)
     else
       {:error, %{reason: :econnrefused}} -> {:error, "Blockchain is not reachable"}
+      {:error, reason} -> {:error, reason}
     end
   end
 
diff --git a/telemetry_api/lib/telemetry_api/ethereum_metrics.ex b/telemetry_api/lib/telemetry_api/ethereum_metrics.ex
@@ -0,0 +1,12 @@
+defmodule TelemetryApi.EthereumMetrics do
+  use Prometheus.Metric
+
+  @gauge [name: :gas_price, help: "Ethereum Gas Price.", labels: []]
+
+  def new_gas_price(gas_price) do
+    Gauge.set(
+      [name: :gas_price, labels: []],
+      gas_price
+    )
+  end
+end
diff --git a/telemetry_api/lib/telemetry_api/metrics_exporter.ex b/telemetry_api/lib/telemetry_api/metrics_exporter.ex
@@ -0,0 +1,3 @@
+defmodule TelemetryApi.MetricsExporter do
+  use Prometheus.PlugExporter
+end
diff --git a/telemetry_api/lib/telemetry_api/periodically.ex b/telemetry_api/lib/telemetry_api/periodically.ex
@@ -1,6 +1,7 @@
-defmodule TelemetryApi.Periodic.OperatorFetcher do
+defmodule TelemetryApi.Periodically do
   use GenServer
   alias TelemetryApi.Operators
+  alias TelemetryApi.EthereumMetrics
   alias TelemetryApi.ContractManagers.RegistryCoordinatorManager
   require Logger
 
@@ -30,6 +31,8 @@ defmodule TelemetryApi.Periodic.OperatorFetcher do
   end
 
   def send_work() do
+    one_second = 1000
+    :timer.send_interval(one_second * 10, :gas_price) # every 10 seconds, once per block + some margin
     :timer.send_interval(@wait_time_ms, :poll_service)
   end
 
@@ -39,6 +42,16 @@ defmodule TelemetryApi.Periodic.OperatorFetcher do
     {:noreply, state}
   end
 
+  def handle_info(:gas_price, _state) do
+    case Ethers.current_gas_price() do
+      {:ok, gas_price} ->
+        EthereumMetrics.new_gas_price(gas_price)
+
+      {:error, error} ->
+        IO.inspect("Error fetching gas price: #{error}")
+    end
+        {:noreply, %{}}
+  end
   defp fetch_operators_info() do
     case Operators.fetch_all_operators() do
       :ok -> :ok
diff --git a/telemetry_api/lib/telemetry_api_web/endpoint.ex b/telemetry_api/lib/telemetry_api_web/endpoint.ex
@@ -44,6 +44,7 @@ defmodule TelemetryApiWeb.Endpoint do
     pass: ["*/*"],
     json_decoder: Phoenix.json_library()
 
+  plug TelemetryApi.MetricsExporter
   plug Plug.MethodOverride
   plug Plug.Head
   plug Plug.Session, @session_options
diff --git a/telemetry_api/mix.exs b/telemetry_api/mix.exs
@@ -13,7 +13,9 @@ defmodule TelemetryApi.MixProject do
           applications: [
             # https://opentelemetry.io/docs/languages/erlang/exporters/#setting-up-the-collector
             opentelemetry_exporter: :permanent,
-            opentelemetry: :temporary
+            opentelemetry: :temporary,
+            prometheus_ex: :permanent,
+            prometheus_plugs: :permanent
           ]
         ]
       ],
@@ -58,7 +60,8 @@ defmodule TelemetryApi.MixProject do
       {:opentelemetry, "~> 1.3"},
       {:opentelemetry_api, "~> 1.2"},
       {:opentelemetry_exporter, "~> 1.6"},
-      {:ex_keccak, "~> 0.7.5"}
+      {:prometheus_ex, "~> 3.0"},
+      {:prometheus_plugs, "~> 1.0"}
     ]
   end
 
diff --git a/telemetry_api/mix.lock b/telemetry_api/mix.lock
@@ -1,4 +1,5 @@
 %{
+  "accept": {:hex, :accept, "0.3.5", "b33b127abca7cc948bbe6caa4c263369abf1347cfa9d8e699c6d214660f10cd1", [:rebar3], [], "hexpm", "11b18c220bcc2eab63b5470c038ef10eb6783bcb1fcdb11aa4137defa5ac1bb8"},
   "acceptor_pool": {:hex, :acceptor_pool, "1.0.0", "43c20d2acae35f0c2bcd64f9d2bde267e459f0f3fd23dab26485bf518c281b21", [:rebar3], [], "hexpm", "0cbcd83fdc8b9ad2eee2067ef8b91a14858a5883cb7cd800e6fcd5803e158788"},
   "bandit": {:hex, :bandit, "1.5.7", "6856b1e1df4f2b0cb3df1377eab7891bec2da6a7fd69dc78594ad3e152363a50", [:mix], [{:hpax, "~> 1.0.0", [hex: :hpax, repo: "hexpm", optional: false]}, {:plug, "~> 1.14", [hex: :plug, repo: "hexpm", optional: false]}, {:telemetry, "~> 0.4 or ~> 1.0", [hex: :telemetry, repo: "hexpm", optional: false]}, {:thousand_island, "~> 1.0", [hex: :thousand_island, repo: "hexpm", optional: false]}, {:websock, "~> 0.5", [hex: :websock, repo: "hexpm", optional: false]}], "hexpm", "f2dd92ae87d2cbea2fa9aa1652db157b6cba6c405cb44d4f6dd87abba41371cd"},
   "castore": {:hex, :castore, "1.0.8", "dedcf20ea746694647f883590b82d9e96014057aff1d44d03ec90f36a5c0dc6e", [:mix], [], "hexpm", "0b2b66d2ee742cb1d9cb8c8be3b43c3a70ee8651f37b75a8b982e036752983f1"},
@@ -47,6 +48,13 @@
   "plug_crypto": {:hex, :plug_crypto, "2.1.0", "f44309c2b06d249c27c8d3f65cfe08158ade08418cf540fd4f72d4d6863abb7b", [:mix], [], "hexpm", "131216a4b030b8f8ce0f26038bc4421ae60e4bb95c5cf5395e1421437824c4fa"},
   "poolboy": {:hex, :poolboy, "1.5.2", "392b007a1693a64540cead79830443abf5762f5d30cf50bc95cb2c1aaafa006b", [:rebar3], [], "hexpm", "dad79704ce5440f3d5a3681c8590b9dc25d1a561e8f5a9c995281012860901e3"},
   "postgrex": {:hex, :postgrex, "0.19.1", "73b498508b69aded53907fe48a1fee811be34cc720e69ef4ccd568c8715495ea", [:mix], [{:db_connection, "~> 2.1", [hex: :db_connection, repo: "hexpm", optional: false]}, {:decimal, "~> 1.5 or ~> 2.0", [hex: :decimal, repo: "hexpm", optional: false]}, {:jason, "~> 1.0", [hex: :jason, repo: "hexpm", optional: true]}, {:table, "~> 0.1.0", [hex: :table, repo: "hexpm", optional: true]}], "hexpm", "8bac7885a18f381e091ec6caf41bda7bb8c77912bb0e9285212829afe5d8a8f8"},
+  "prometheus": {:hex, :prometheus, "4.11.0", "b95f8de8530f541bd95951e18e355a840003672e5eda4788c5fa6183406ba29a", [:mix, :rebar3], [{:quantile_estimator, "~> 0.2.1", [hex: :quantile_estimator, repo: "hexpm", optional: false]}], "hexpm", "719862351aabf4df7079b05dc085d2bbcbe3ac0ac3009e956671b1d5ab88247d"},
+  "prometheus_ecto": {:hex, :prometheus_ecto, "1.4.3", "3dd4da1812b8e0dbee81ea58bb3b62ed7588f2eae0c9e97e434c46807ff82311", [:mix], [{:ecto, "~> 2.0 or ~> 3.0", [hex: :ecto, repo: "hexpm", optional: false]}, {:prometheus_ex, "~> 1.1 or ~> 2.0 or ~> 3.0", [hex: :prometheus_ex, repo: "hexpm", optional: false]}], "hexpm", "8d66289f77f913b37eda81fd287340c17e61a447549deb28efc254532b2bed82"},
+  "prometheus_ex": {:hex, :prometheus_ex, "3.1.0", "98bdb1e9aea5001bc5f58752259d832447c06dd335cb246e89b497e2c4ec7de6", [:mix], [{:prometheus, "~> 4.0", [hex: :prometheus, repo: "hexpm", optional: false]}], "hexpm", "bc584d33aabae94ce75d477eb66c7178755b45a09afb7addb253d90eb66021de"},
+  "prometheus_phoenix": {:hex, :prometheus_phoenix, "1.3.0", "c4b527e0b3a9ef1af26bdcfbfad3998f37795b9185d475ca610fe4388fdd3bb5", [:mix], [{:phoenix, "~> 1.4", [hex: :phoenix, repo: "hexpm", optional: false]}, {:prometheus_ex, "~> 1.3 or ~> 2.0 or ~> 3.0", [hex: :prometheus_ex, repo: "hexpm", optional: false]}], "hexpm", "c4d1404ac4e9d3d963da601db2a7d8ea31194f0017057fabf0cfb9bf5a6c8c75"},
+  "prometheus_plugs": {:hex, :prometheus_plugs, "1.1.5", "25933d48f8af3a5941dd7b621c889749894d8a1082a6ff7c67cc99dec26377c5", [:mix], [{:accept, "~> 0.1", [hex: :accept, repo: "hexpm", optional: false]}, {:plug, "~> 1.0", [hex: :plug, repo: "hexpm", optional: false]}, {:prometheus_ex, "~> 1.1 or ~> 2.0 or ~> 3.0", [hex: :prometheus_ex, repo: "hexpm", optional: false]}, {:prometheus_process_collector, "~> 1.1", [hex: :prometheus_process_collector, repo: "hexpm", optional: true]}], "hexpm", "0273a6483ccb936d79ca19b0ab629aef0dba958697c94782bb728b920dfc6a79"},
+  "prometheus_process_collector": {:hex, :prometheus_process_collector, "1.6.0", "b169e224337497cd858da16f9361edabc5931b9d12201a97ee15d88ef5a6fcaa", [:rebar3], [{:prometheus, "~> 4.0", [hex: :prometheus, repo: "hexpm", optional: false]}], "hexpm", "e9cd9846f204de7a04863f56308d8d1193bec714210bf6374d9d4fc088d2896d"},
+  "quantile_estimator": {:hex, :quantile_estimator, "0.2.1", "ef50a361f11b5f26b5f16d0696e46a9e4661756492c981f7b2229ef42ff1cd15", [:rebar3], [], "hexpm", "282a8a323ca2a845c9e6f787d166348f776c1d4a41ede63046d72d422e3da946"},
   "rustler_precompiled": {:hex, :rustler_precompiled, "0.8.1", "8afe0b6f3a9a677ada046cdd23e3f4c6399618b91a6122289324774961281e1e", [:mix], [{:castore, "~> 0.1 or ~> 1.0", [hex: :castore, repo: "hexpm", optional: false]}, {:rustler, "~> 0.23", [hex: :rustler, repo: "hexpm", optional: true]}], "hexpm", "90b8c2297bf7959cfa1c927b2881faad7bb0707183124955369991b76177a166"},
   "ssl_verify_fun": {:hex, :ssl_verify_fun, "1.1.7", "354c321cf377240c7b8716899e182ce4890c5938111a1296add3ec74cf1715df", [:make, :mix, :rebar3], [], "hexpm", "fe4c190e8f37401d30167c8c405eda19469f34577987c76dde613e838bbc67f8"},
   "telemetry": {:hex, :telemetry, "1.3.0", "fedebbae410d715cf8e7062c96a1ef32ec22e764197f70cda73d82778d61e7a2", [:rebar3], [], "hexpm", "7015fc8919dbe63764f4b4b87a95b7c0996bd539e0d499be6ec9d7f3875b79e6"},
diff --git a/telemetry_api/start.sh b/telemetry_api/start.sh
@@ -2,17 +2,6 @@
 
 source .env
 
-# Add new environment variables here
-env_vars=(
-  "ENVIRONMENT"
-  "ALIGNED_CONFIG_FILE"
-  "OPERATOR_FETCHER_WAIT_TIME_MS"
-)
-
-for var in "${env_vars[@]}"; do
-  export "$var=${!var}"
-done
-
 mix compile --force #force recompile to get the latest .env values
 
 elixir --sname telemetry -S mix phx.server

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+defmodule TelemetryApi.MetricsExporter do`
	`2`	`+ use Prometheus.PlugExporter`
	`3`	`+end`