Add more statistics (#18)

Author: mickel8

.github/workflows/ci.yml

@@ -6,8 +6,8 @@ jobs:
     name: lint OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
     strategy:
       matrix:
-        otp: ['25']
-        elixir: ['1.13.2']
+        otp: ['26']
+        elixir: ['1.15']
     steps:
       - uses: actions/checkout@v2
       - uses: erlef/setup-beam@v1
@@ -24,8 +24,8 @@ jobs:
     name: test OTP ${{matrix.otp}} / Elixir ${{matrix.elixir}}
     strategy:
       matrix:
-        otp: ['25']
-        elixir: ['1.13.2']
+        otp: ['26']
+        elixir: ['1.15']
     env:
       MIX_ENV: test
       GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

README.md

@@ -27,7 +27,7 @@ as WebRTC multiplexes traffic on a single socket but PRs are welcomed
 ```elixir
 def deps do
   [
-    {:ex_ice, "~> 0.5.0"}
+    {:ex_ice, "~> 0.6.0"}
   ]
 end
 ```

lib/candidate.ex

@@ -3,9 +3,12 @@ defmodule ExICE.Candidate do
   ICE candidate representation.
   """
 
+  alias ExICE.Utils
+
   @type type() :: :host | :srflx | :prflx | :relay
 
   @type t() :: %__MODULE__{
+          id: integer(),
           address: :inet.ip_address(),
           base_address: :inet.ip_address() | nil,
           base_port: :inet.port_number() | nil,
@@ -19,6 +22,7 @@ defmodule ExICE.Candidate do
 
   @derive {Inspect, except: [:socket]}
   defstruct [
+    :id,
     :address,
     :base_address,
     :base_port,
@@ -46,6 +50,7 @@ defmodule ExICE.Candidate do
     priority = opts[:priority] || priority(type)
 
     %__MODULE__{
+      id: Utils.id(),
       address: address,
       base_address: base_address,
       base_port: base_port,
@@ -90,6 +95,7 @@ defmodule ExICE.Candidate do
          {:ok, type} <- parse_type(ty_str) do
       {:ok,
        %__MODULE__{
+         id: Utils.id(),
          address: address,
          foundation: foundation,
          port: port,

lib/candidate_pair.ex

@@ -4,8 +4,7 @@ defmodule ExICE.CandidatePair do
   """
   require Logger
 
-  alias ExICE.ICEAgent
-  alias ExICE.Candidate
+  alias ExICE.{Candidate, ICEAgent, Utils}
 
   # Tr timeout (keepalives) in ms
   @tr_timeout 15 * 1000
@@ -43,10 +42,8 @@ defmodule ExICE.CandidatePair do
   def new(local_cand, remote_cand, agent_role, state, opts \\ []) do
     priority = priority(agent_role, local_cand, remote_cand)
 
-    <<id::12*8>> = :crypto.strong_rand_bytes(12)
-
     %__MODULE__{
-      id: id,
+      id: Utils.id(),
       local_cand: local_cand,
       remote_cand: remote_cand,
       priority: priority,

lib/ice_agent.ex

@@ -211,11 +211,20 @@ defmodule ExICE.ICEAgent do
 
   * `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.
+  * `packets_sent` - data packets sent. This does not include connectivity checks.
+  * `packets_received` - data packets received. This does not include connectivity checks.
+  * `candidate_pairs` - list of current candidate pairs. Changes after doing an ICE restart.
   """
   @spec get_stats(pid()) :: %{
           bytes_sent: non_neg_integer(),
-          bytes_received: non_neg_integer,
+          bytes_received: non_neg_integer(),
+          packets_sent: non_neg_integer(),
+          packets_received: non_neg_integer(),
+          state: atom(),
+          role: atom(),
+          local_ufrag: binary(),
+          local_candidates: [Candidate.t()],
+          remote_candidates: [Candidate.t()],
           candidate_pairs: [CandidatePair.t()]
         }
   def get_stats(ice_agent) do
@@ -299,7 +308,9 @@ defmodule ExICE.ICEAgent do
       turn_servers: [],
       # stats
       bytes_sent: 0,
-      bytes_received: 0
+      bytes_received: 0,
+      packets_sent: 0,
+      packets_received: 0
     }
 
     {:ok, state}
@@ -335,6 +346,13 @@ defmodule ExICE.ICEAgent do
     stats = %{
       bytes_sent: state.bytes_sent,
       bytes_received: state.bytes_received,
+      packets_sent: state.packets_sent,
+      packets_received: state.packets_received,
+      state: state.state,
+      role: state.role,
+      local_ufrag: state.local_ufrag,
+      local_candidates: state.local_cands,
+      remote_candidates: state.remote_cands,
       candidate_pairs: Map.values(state.checklist)
     }
 
@@ -470,7 +488,15 @@ defmodule ExICE.ICEAgent do
 
     dst = {pair.remote_cand.address, pair.remote_cand.port}
     bytes_sent = do_send(pair.local_cand.socket, dst, data)
-    {:noreply, %{state | bytes_sent: state.bytes_sent + bytes_sent}}
+    # if we didn't manage to send any bytes, don't increment packets_sent
+    packets_sent = if bytes_sent == 0, do: 0, else: 1
+
+    {:noreply,
+     %{
+       state
+       | bytes_sent: state.bytes_sent + bytes_sent,
+         packets_sent: state.packets_sent + packets_sent
+     }}
   end
 
   @impl true
@@ -617,7 +643,13 @@ defmodule ExICE.ICEAgent do
       end
     else
       notify(state.on_data, {:data, packet})
-      {:noreply, %{state | bytes_received: state.bytes_received + byte_size(packet)}}
+
+      {:noreply,
+       %{
+         state
+         | bytes_received: state.bytes_received + byte_size(packet),
+           packets_received: state.packets_received + 1
+       }}
     end
   end
 

lib/utils.ex

@@ -8,4 +8,10 @@ defmodule ExICE.Utils do
       {_, _, _, _, _, _, _, _} -> :ipv6
     end
   end
+
+  @spec id() :: non_neg_integer()
+  def id() do
+    <<id::12*8>> = :crypto.strong_rand_bytes(12)
+    id
+  end
 end

mix.exs

@@ -1,7 +1,7 @@
 defmodule ExICE.MixProject do
   use Mix.Project
 
-  @version "0.5.0"
+  @version "0.6.0"
   @source_url "https://github.com/elixir-webrtc/ex_ice"
 
   def project do

test/candidate_test.exs

@@ -36,7 +36,7 @@ defmodule ExICE.CandidateTest do
     expected_c = Candidate.new(:host, ip, port, nil, nil, nil, priority: 1234)
 
     assert {:ok, c} = Candidate.unmarshal(m_c)
-
+    c = %Candidate{c | id: expected_c.id}
     assert c == expected_c
   end
 end

test/ice_agent_test.exs

@@ -21,9 +21,21 @@ defmodule ExICE.ICEAgentTest do
   test "get_stats/1" do
     {:ok, agent} = ICEAgent.start_link(:controlling)
 
-    assert %{bytes_sent: 0, bytes_received: 0, candidate_pairs: candidate_pairs} =
+    assert %{
+             bytes_sent: 0,
+             bytes_received: 0,
+             packets_sent: 0,
+             packets_received: 0,
+             state: :new,
+             role: :controlling,
+             local_ufrag: local_ufrag,
+             local_candidates: [],
+             remote_candidates: [],
+             candidate_pairs: candidate_pairs
+           } =
              ICEAgent.get_stats(agent)
 
     assert is_list(candidate_pairs)
+    assert is_binary(local_ufrag)
   end
 end