Add logger_metadata option to PeerConnection

Author: Karolk99

lib/ex_webrtc/dtls_transport.ex

@@ -46,15 +46,33 @@ defmodule ExWebRTC.DTLSTransport do
           base64_certificate: binary()
         }
 
-  @spec start_link(ICETransport.t(), pid()) :: GenServer.on_start()
-  def start_link(ice_transport \\ DefaultICETransport, ice_pid) do
+  @typedoc """
+  DTLS Transport configuration options
+
+  * `ice_transport` - the module implementing the `ExICE.ICETransport` behavior.
+  * `ice_pid` - the PID of the ICE transport process which the DTLSTransport interacts with.
+  * `logger_metadata` - a keyword list of metadata to be attached to the Logger for all logs emitted by the DTLSTransport process.
+  """
+  @type opts() :: [
+          ice_transport: ICETransport.t(),
+          ice_pid: pid(),
+          logger_metadata: Enumerable.t({atom(), term()})
+        ]
+
+  @spec start_link(opts()) :: GenServer.on_start()
+  def start_link(opts) do
+    ice_transport = opts[:ice_transport] || DefaultICETransport
+    logger_metadata = opts[:logger_metadata] || []
+
+    ice_pid = Keyword.fetch!(opts, :ice_pid)
+
     behaviour = ice_transport.__info__(:attributes)[:behaviour] || []
 
     unless ICETransport in behaviour do
       raise "DTLSTransport requires ice_transport to implement ExWebRTC.ICETransport behaviour."
     end
 
-    GenServer.start_link(__MODULE__, [ice_transport, ice_pid, self()])
+    GenServer.start_link(__MODULE__, [ice_transport, ice_pid, self(), logger_metadata])
   end
 
   @spec set_ice_connected(dtls_transport()) :: :ok
@@ -117,7 +135,9 @@ defmodule ExWebRTC.DTLSTransport do
   end
 
   @impl true
-  def init([ice_transport, ice_pid, owner]) do
+  def init([ice_transport, ice_pid, owner, logger_metadata]) do
+    Logger.metadata(logger_metadata)
+
     {pkey, cert} = ExDTLS.generate_key_cert()
     fingerprint = ExDTLS.get_cert_fingerprint(cert)
 

lib/ex_webrtc/peer_connection.ex

@@ -605,6 +605,8 @@ defmodule ExWebRTC.PeerConnection do
 
   @impl true
   def handle_continue(config, _state) do
+    Logger.metadata(config.logger_metadata)
+
     {:ok, _} = Registry.register(ExWebRTC.Registry, self(), self())
 
     ice_config = [
@@ -614,11 +616,20 @@ defmodule ExWebRTC.PeerConnection do
       aggressive_nomination: config.ice_aggressive_nomination,
       host_to_srflx_ip_mapper: config.host_to_srflx_ip_mapper,
       ports: config.ice_port_range,
-      on_data: nil
+      on_data: nil,
+      logger_metadata: config.logger_metadata
     ]
 
     {:ok, ice_pid} = DefaultICETransport.start_link(ice_config)
-    {:ok, dtls_transport} = DTLSTransport.start_link(DefaultICETransport, ice_pid)
+
+    dtls_config = [
+      ice_transport: DefaultICETransport,
+      ice_pid: ice_pid,
+      logger_metadata: config.logger_metadata
+    ]
+
+    {:ok, dtls_transport} = DTLSTransport.start_link(dtls_config)
+
     # route data to the DTLSTransport
     :ok = DefaultICETransport.on_data(ice_pid, dtls_transport)
 

lib/ex_webrtc/peer_connection/configuration.ex

@@ -158,6 +158,7 @@ defmodule ExWebRTC.PeerConnection.Configuration do
   * `ice_ip_filter` - filter applied when gathering local candidates. By default, all IP addresses are accepted.
   * `ice_port_range` - range of ports that ICE will use for gathering host candidates. Defaults to ephemeral ports.
   * `ice_aggressive_nomination` - whether ICE agent should use aggressive nomination. By default, ICE agent
+  * `logger_metadata` - a keyword list of metadata to be attached to the Logger for all logs emitted by the PeerConnection and its child processes.
   relies on the regular nomination defined in RFC 8445. However, some WebRTC implementations require
   the controlling side to nominate a pair before they can start sending data (e.g. Pion, Firefox).
   This can result in longer, connection establishment time as regular nomination nominates only one pair,
@@ -205,7 +206,8 @@ defmodule ExWebRTC.PeerConnection.Configuration do
           video_codecs: [RTPCodecParameters.t()] | [video_codec_name()],
           features: [feature()],
           rtp_header_extensions: [rtp_header_extension()],
-          rtcp_feedbacks: [rtcp_feedback()]
+          rtcp_feedbacks: [rtcp_feedback()],
+          logger_metadata: Enumerable.t({atom(), term()})
         ]
 
   @typedoc """
@@ -226,7 +228,8 @@ defmodule ExWebRTC.PeerConnection.Configuration do
           video_codecs: [RTPCodecParameters.t()],
           audio_extensions: [Extmap.t()],
           video_extensions: [Extmap.t()],
-          features: [feature()]
+          features: [feature()],
+          logger_metadata: Enumerable.t({atom(), term()})
         }
 
   @enforce_keys [
@@ -244,7 +247,8 @@ defmodule ExWebRTC.PeerConnection.Configuration do
                 host_to_srflx_ip_mapper: nil,
                 audio_codecs: @default_audio_codecs,
                 video_codecs: @default_video_codecs,
-                features: @default_features
+                features: @default_features,
+                logger_metadata: []
               ]
 
   @doc """

mix.exs

@@ -57,7 +57,7 @@ defmodule ExWebRTC.MixProject do
   defp deps do
     [
       {:ex_sdp, "~> 1.0"},
-      {:ex_ice, github: "elixir-webrtc/ex_ice"},
+      {:ex_ice, github: "elixir-webrtc/ex_ice", branch: "logger-metadata"},
       {:ex_dtls, "~> 0.18.0"},
       {:ex_libsrtp, "~> 0.7.1"},
       {:ex_rtp, "~> 0.4.0"},

mix.lock

@@ -12,7 +12,7 @@
   "erlex": {:hex, :erlex, "0.2.7", "810e8725f96ab74d17aac676e748627a07bc87eb950d2b83acd29dc047a30595", [:mix], [], "hexpm", "3ed95f79d1a844c3f6bf0cea61e0d5612a42ce56da9c03f01df538685365efb0"},
   "ex_doc": {:hex, :ex_doc, "0.38.2", "504d25eef296b4dec3b8e33e810bc8b5344d565998cd83914ffe1b8503737c02", [:mix], [{:earmark_parser, "~> 1.4.44", [hex: :earmark_parser, repo: "hexpm", optional: false]}, {:makeup_c, ">= 0.1.0", [hex: :makeup_c, repo: "hexpm", optional: true]}, {:makeup_elixir, "~> 0.14 or ~> 1.0", [hex: :makeup_elixir, repo: "hexpm", optional: false]}, {:makeup_erlang, "~> 0.1 or ~> 1.0", [hex: :makeup_erlang, repo: "hexpm", optional: false]}, {:makeup_html, ">= 0.1.0", [hex: :makeup_html, repo: "hexpm", optional: true]}], "hexpm", "732f2d972e42c116a70802f9898c51b54916e542cc50968ac6980512ec90f42b"},
   "ex_dtls": {:hex, :ex_dtls, "0.18.0", "0815e3384bb0c1e6c06559012479cf9a94a501ddf46c3df54dc2d1b169e29d5c", [:mix], [{:bundlex, "~> 1.5.3", [hex: :bundlex, repo: "hexpm", optional: false]}, {:unifex, "~> 1.0", [hex: :unifex, repo: "hexpm", optional: false]}], "hexpm", "562eda1815eeaed8360b2b5c34d4db5b453794bc096404a4c64f193fa7b18bf2"},
-  "ex_ice": {:git, "https://github.com/elixir-webrtc/ex_ice.git", "a4f930b19a1e92c5bbaf64e24e0035942f6ff280", []},
+  "ex_ice": {:git, "https://github.com/elixir-webrtc/ex_ice.git", "5776db9cf06da6b664539df1522f5d136957484c", [branch: "logger-metadata"]},
   "ex_libsrtp": {:hex, :ex_libsrtp, "0.7.2", "211bd89c08026943ce71f3e2c0231795b99cee748808ed3ae7b97cd8d2450b6b", [:mix], [{:bunch, "~> 1.6", [hex: :bunch, repo: "hexpm", optional: false]}, {:bundlex, "~> 1.3", [hex: :bundlex, repo: "hexpm", optional: false]}, {:membrane_precompiled_dependency_provider, "~> 0.1.0", [hex: :membrane_precompiled_dependency_provider, repo: "hexpm", optional: false]}, {:unifex, "~> 1.1", [hex: :unifex, repo: "hexpm", optional: false]}], "hexpm", "2e20645d0d739a4ecdcf8d4810a0c198120c8a2f617f2b75b2e2e704d59f492a"},
   "ex_rtcp": {:hex, :ex_rtcp, "0.4.0", "f9e515462a9581798ff6413583a25174cfd2101c94a2ebee871cca7639886f0a", [:mix], [], "hexpm", "28956602cf210d692fcdaf3f60ca49681634e1deb28ace41246aee61ee22dc3b"},
   "ex_rtp": {:hex, :ex_rtp, "0.4.0", "1f1b5c1440a904706011e3afbb41741f5da309ce251cb986690ce9fd82636658", [:mix], [], "hexpm", "0f72d80d5953a62057270040f0f1ee6f955c08eeae82ac659c038001d7d5a790"},

test/ex_webrtc/dtls_transport_test.exs

@@ -118,7 +118,10 @@ defmodule ExWebRTC.DTLSTransportTest do
 
   setup do
     {:ok, ice_pid} = MockICETransport.start_link(tester: self())
-    assert {:ok, dtls} = DTLSTransport.start_link(MockICETransport, ice_pid)
+
+    assert {:ok, dtls} =
+             DTLSTransport.start_link(ice_transport: MockICETransport, ice_pid: ice_pid)
+
     MockICETransport.on_data(ice_pid, dtls)
     assert_receive {:dtls_transport, ^dtls, {:state_change, :new}}