Track number of data bytes sent and received

Author: mickel8

lib/ice_agent.ex

@@ -206,6 +206,22 @@ defmodule ExICE.ICEAgent do
     GenServer.cast(ice_agent, {:send_data, data})
   end
 
+  @doc """
+  Gathers ICE agent statistics.
+
+  * `bytes_sent` - data bytes sent. This does not include connectivity checks and UDP/IP header sizes.
+  * `bytes_received` - data bytes received. This does not include connectivity checks and UDP/IP header sizes.
+  * `candidate_pairs` - list of current candidate pairs. It will change after doing an ICE restart.
+  """
+  @spec get_stats(pid()) :: %{
+          bytes_sent: non_neg_integer(),
+          bytes_received: non_neg_integer,
+          candidate_pairs: [CandidatePair.t()]
+        }
+  def get_stats(ice_agent) do
+    GenServer.call(ice_agent, :get_stats)
+  end
+
   @doc """
   Restarts ICE.
 
@@ -280,7 +296,10 @@ defmodule ExICE.ICEAgent do
       remote_pwd: nil,
       remote_cands: [],
       stun_servers: stun_servers,
-      turn_servers: []
+      turn_servers: [],
+      # stats
+      bytes_sent: 0,
+      bytes_received: 0
     }
 
     {:ok, state}
@@ -311,6 +330,17 @@ defmodule ExICE.ICEAgent do
     {:reply, {:ok, state.local_ufrag, state.local_pwd}, state}
   end
 
+  @impl true
+  def handle_call(:get_stats, _from, state) do
+    stats = %{
+      bytes_sent: state.bytes_sent,
+      bytes_received: state.bytes_received,
+      candidate_pairs: Map.values(state.checklist)
+    }
+
+    {:reply, stats, state}
+  end
+
   @impl true
   def handle_cast(
         {:set_remote_credentials, ufrag, pwd},
@@ -439,8 +469,8 @@ defmodule ExICE.ICEAgent do
         List.first(state.prev_valid_pairs)
 
     dst = {pair.remote_cand.address, pair.remote_cand.port}
-    do_send(pair.local_cand.socket, dst, data)
-    {:noreply, state}
+    bytes_sent = do_send(pair.local_cand.socket, dst, data)
+    {:noreply, %{state | bytes_sent: state.bytes_sent + bytes_sent}}
   end
 
   @impl true
@@ -587,7 +617,7 @@ defmodule ExICE.ICEAgent do
       end
     else
       notify(state.on_data, {:data, packet})
-      {:noreply, state}
+      {:noreply, %{state | bytes_received: state.bytes_received + byte_size(packet)}}
     end
   end
 
@@ -1716,17 +1746,19 @@ defmodule ExICE.ICEAgent do
     # retrying after getting EPERM seems to help
     case :gen_udp.send(socket, dst, data) do
       :ok ->
-        :ok
+        byte_size(data)
 
       err ->
         Logger.error("UDP send error: #{inspect(err)}. Retrying...")
 
         case :gen_udp.send(socket, dst, data) do
           :ok ->
             Logger.debug("Successful retry")
+            byte_size(data)
 
           err ->
             Logger.error("Unseccessful retry: #{inspect(err)}. Giving up.")
+            0
         end
     end
   end

test/ice_agent_test.exs

@@ -3,7 +3,7 @@ defmodule ExICE.ICEAgentTest do
 
   alias ExICE.ICEAgent
 
-  test "gathering candidates" do
+  test "gather_candidates/1" do
     {:ok, agent} = ICEAgent.start_link(:controlling)
     :ok = ICEAgent.gather_candidates(agent)
 
@@ -17,4 +17,13 @@ defmodule ExICE.ICEAgentTest do
     assert_receive {:ex_ice, ^agent, {:gathering_state_change, :gathering}}
     assert_receive {:ex_ice, ^agent, {:gathering_state_change, :complete}}
   end
+
+  test "get_stats/1" do
+    {:ok, agent} = ICEAgent.start_link(:controlling)
+
+    assert %{bytes_sent: 0, bytes_received: 0, candidate_pairs: candidate_pairs} =
+             ICEAgent.get_stats(agent)
+
+    assert is_list(candidate_pairs)
+  end
 end