Add initial missing telemetry spans for live component updates

phoenixframework · Oct 14, 2024 · 9073648 · 9073648
1 parent ebca5e7
commit 9073648
Show file tree

Hide file tree

Showing 3 changed files with 39 additions and 14 deletions.
diff --git a/lib/phoenix_live_view/diff.ex b/lib/phoenix_live_view/diff.ex
@@ -265,7 +265,19 @@ defmodule Phoenix.LiveView.Diff do
 
         {diff, new_components, :noop} =
           write_component(socket, cid, components, fn component_socket, component ->
-            {Utils.maybe_call_update!(component_socket, component, updated_assigns), :noop}
+            telemetry_metadata = %{
+              socket: component_socket,
+              component: component,
+              assigns_sockets: updated_assigns
+            }
+
+            sockets =
+              :telemetry.span([:phoenix, :live_component, :update], telemetry_metadata, fn ->
+                {Utils.maybe_call_update!(component_socket, component, updated_assigns),
+                 telemetry_metadata}
+              end)
+
+            {sockets, :noop}
           end)
 
         {diff, new_components}
@@ -326,9 +338,20 @@ defmodule Phoenix.LiveView.Diff do
     socket = mount_component(socket, component, mount_assigns)
     assigns = maybe_call_preload!(component, assigns)
 
-    socket
-    |> Utils.maybe_call_update!(component, assigns)
-    |> component_to_rendered(component, assigns[:id])
+    telemetry_metadata = %{
+      socket: socket,
+      component: component,
+      assigns_sockets: assigns
+    }
+
+    :telemetry.span([:phoenix, :live_component, :update], telemetry_metadata, fn ->
+      result =
+        socket
+        |> Utils.maybe_call_update!(component, assigns)
+        |> component_to_rendered(component, assigns[:id])
+
+      {result, telemetry_metadata}
+    end)
   end
 
   defp component_to_rendered(socket, component, id) do

diff --git a/lib/phoenix_live_view/engine.ex b/lib/phoenix_live_view/engine.ex
@@ -128,14 +128,15 @@ defmodule Phoenix.LiveView.Rendered do
 
   @type t :: %__MODULE__{
           static: [String.t()],
-          dynamic: (boolean() ->
-                      [
-                        nil
-                        | iodata()
-                        | Phoenix.LiveView.Rendered.t()
-                        | Phoenix.LiveView.Comprehension.t()
-                        | Phoenix.LiveView.Component.t()
-                      ]),
+          dynamic:
+            (boolean() ->
+               [
+                 nil
+                 | iodata()
+                 | Phoenix.LiveView.Rendered.t()
+                 | Phoenix.LiveView.Comprehension.t()
+                 | Phoenix.LiveView.Component.t()
+               ]),
           fingerprint: integer(),
           root: nil | true | false,
           caller:

diff --git a/lib/phoenix_live_view/upload_config.ex b/lib/phoenix_live_view/upload_config.ex
@@ -122,8 +122,9 @@ defmodule Phoenix.LiveView.UploadConfig do
           errors: list(),
           ref: String.t(),
           auto_upload?: boolean(),
-          writer: (name :: atom() | String.t(), UploadEntry.t(), Phoenix.LiveView.Socket.t() ->
-                     {module(), term()}),
+          writer:
+            (name :: atom() | String.t(), UploadEntry.t(), Phoenix.LiveView.Socket.t() ->
+               {module(), term()}),
           progress_event:
             (name :: atom() | String.t(), UploadEntry.t(), Phoenix.LiveView.Socket.t() ->
                {:noreply, Phoenix.LiveView.Socket.t()})