fix: collect global metrics without tenant tagging (#1557)

Author: edgurgel

lib/realtime/monitoring/prom_ex/plugins/tenant.ex

@@ -157,20 +157,38 @@ defmodule Realtime.PromEx.Plugins.Tenant do
           description: "Sum of messages sent on a Realtime Channel.",
           tags: [:tenant]
         ),
+        sum(
+          [:realtime, :channel, :global, :events],
+          event_name: [:realtime, :rate_counter, :channel, :events],
+          measurement: :sum,
+          description: "Global sum of messages sent on a Realtime Channel."
+        ),
         sum(
           [:realtime, :channel, :presence_events],
           event_name: [:realtime, :rate_counter, :channel, :presence_events],
           measurement: :sum,
           description: "Sum of presence messages sent on a Realtime Channel.",
           tags: [:tenant]
         ),
+        sum(
+          [:realtime, :channel, :global, :presence_events],
+          event_name: [:realtime, :rate_counter, :channel, :presence_events],
+          measurement: :sum,
+          description: "Global sum of presence messages sent on a Realtime Channel."
+        ),
         sum(
           [:realtime, :channel, :db_events],
           event_name: [:realtime, :rate_counter, :channel, :db_events],
           measurement: :sum,
           description: "Sum of db messages sent on a Realtime Channel.",
           tags: [:tenant]
         ),
+        sum(
+          [:realtime, :channel, :global, :db_events],
+          event_name: [:realtime, :rate_counter, :channel, :db_events],
+          measurement: :sum,
+          description: "Global sum of db messages sent on a Realtime Channel."
+        ),
         sum(
           [:realtime, :channel, :joins],
           event_name: [:realtime, :rate_counter, :channel, :joins],

lib/realtime/monitoring/prom_ex/plugins/tenants.ex

@@ -21,6 +21,15 @@ defmodule Realtime.PromEx.Plugins.Tenants do
         unit: {:microsecond, :millisecond},
         tags: [:success, :tenant, :mechanism],
         reporter_options: [buckets: [10, 250, 5000, 15_000]]
+      ),
+      distribution(
+        [:realtime, :global, :rpc],
+        event_name: [:realtime, :rpc],
+        description: "Global Latency of rpc calls",
+        measurement: :latency,
+        unit: {:microsecond, :millisecond},
+        tags: [:success, :mechanism],
+        reporter_options: [buckets: [10, 250, 5000, 15_000]]
       )
     ])
   end

mix.exs

@@ -4,7 +4,7 @@ defmodule Realtime.MixProject do
   def project do
     [
       app: :realtime,
-      version: "2.51.14",
+      version: "2.51.15",
       elixir: "~> 1.17.3",
       elixirc_paths: elixirc_paths(Mix.env()),
       start_permanent: Mix.env() == :prod,

test/realtime/monitoring/prom_ex/plugins/tenant_test.exs

@@ -129,6 +129,17 @@ defmodule Realtime.PromEx.Plugins.TenantTest do
       assert metric_value(pattern) == metric_value + 1
     end
 
+    test "global event exists after counter added", %{tenant: %{external_id: external_id}} do
+      pattern =
+        ~r/realtime_channel_global_events\s(?<number>\d+)/
+
+      metric_value = metric_value(pattern)
+      FakeUserCounter.fake_event(external_id)
+
+      Process.sleep(200)
+      assert metric_value(pattern) == metric_value + 1
+    end
+
     test "db_event exists after counter added", %{tenant: %{external_id: external_id}} do
       pattern =
         ~r/realtime_channel_db_events{tenant="#{external_id}"}\s(?<number>\d+)/
@@ -139,6 +150,16 @@ defmodule Realtime.PromEx.Plugins.TenantTest do
       assert metric_value(pattern) == metric_value + 1
     end
 
+    test "global db_event exists after counter added", %{tenant: %{external_id: external_id}} do
+      pattern =
+        ~r/realtime_channel_global_db_events\s(?<number>\d+)/
+
+      metric_value = metric_value(pattern)
+      FakeUserCounter.fake_db_event(external_id)
+      Process.sleep(200)
+      assert metric_value(pattern) == metric_value + 1
+    end
+
     test "presence_event exists after counter added", %{tenant: %{external_id: external_id}} do
       pattern =
         ~r/realtime_channel_presence_events{tenant="#{external_id}"}\s(?<number>\d+)/
@@ -149,6 +170,16 @@ defmodule Realtime.PromEx.Plugins.TenantTest do
       assert metric_value(pattern) == metric_value + 1
     end
 
+    test "global presence_event exists after counter added", %{tenant: %{external_id: external_id}} do
+      pattern =
+        ~r/realtime_channel_global_presence_events\s(?<number>\d+)/
+
+      metric_value = metric_value(pattern)
+      FakeUserCounter.fake_presence_event(external_id)
+      Process.sleep(200)
+      assert metric_value(pattern) == metric_value + 1
+    end
+
     test "metric read_authorization_check exists after check", context do
       pattern =
         ~r/realtime_tenants_read_authorization_check_count{tenant="#{context.tenant.external_id}"}\s(?<number>\d+)/

test/realtime/monitoring/prom_ex/plugins/tenants_test.exs

@@ -37,6 +37,16 @@ defmodule Realtime.PromEx.Plugins.TenantsTest do
       assert metric_value(pattern) == previous_value + 1
     end
 
+    test "global success" do
+      pattern = ~r/realtime_global_rpc_count{mechanism=\"erpc\",success="true"}\s(?<number>\d+)/
+      # Enough time for the poll rate to be triggered at least once
+      Process.sleep(200)
+      previous_value = metric_value(pattern)
+      assert {:ok, "success"} = Rpc.enhanced_call(node(), Test, :success, [], tenant_id: "123")
+      Process.sleep(200)
+      assert metric_value(pattern) == previous_value + 1
+    end
+
     test "failure" do
       pattern = ~r/realtime_rpc_count{mechanism=\"erpc\",success="false",tenant="123"}\s(?<number>\d+)/
       # Enough time for the poll rate to be triggered at least once
@@ -47,6 +57,16 @@ defmodule Realtime.PromEx.Plugins.TenantsTest do
       assert metric_value(pattern) == previous_value + 1
     end
 
+    test "global failure" do
+      pattern = ~r/realtime_global_rpc_count{mechanism=\"erpc\",success="false"}\s(?<number>\d+)/
+      # Enough time for the poll rate to be triggered at least once
+      Process.sleep(200)
+      previous_value = metric_value(pattern)
+      assert {:error, "failure"} = Rpc.enhanced_call(node(), Test, :failure, [], tenant_id: "123")
+      Process.sleep(200)
+      assert metric_value(pattern) == previous_value + 1
+    end
+
     test "exception" do
       pattern = ~r/realtime_rpc_count{mechanism=\"erpc\",success="false",tenant="123"}\s(?<number>\d+)/
       # Enough time for the poll rate to be triggered at least once
@@ -59,6 +79,19 @@ defmodule Realtime.PromEx.Plugins.TenantsTest do
       Process.sleep(200)
       assert metric_value(pattern) == previous_value + 1
     end
+
+    test "global exception" do
+      pattern = ~r/realtime_global_rpc_count{mechanism=\"erpc\",success="false"}\s(?<number>\d+)/
+      # Enough time for the poll rate to be triggered at least once
+      Process.sleep(200)
+      previous_value = metric_value(pattern)
+
+      assert {:error, :rpc_error, %RuntimeError{message: "runtime error"}} =
+               Rpc.enhanced_call(node(), Test, :exception, [], tenant_id: "123")
+
+      Process.sleep(200)
+      assert metric_value(pattern) == previous_value + 1
+    end
   end
 
   test "event_metrics rpc" do