Merge pull request #215 from liquidvotingio/add-opentelemetry

Extend the span attributes & improve the span name.

Author: oliverbarnes

lib/liquid_voting/voting.ex

@@ -2,12 +2,13 @@ defmodule LiquidVoting.Voting do
   @moduledoc """
   The Voting context.
   """
+
   require OpenTelemetry.Tracer, as: Tracer
 
   import Ecto.Query, warn: false
 
-  alias __MODULE__.{Vote, Participant}
-  alias LiquidVoting.{Repo, Delegations}
+  alias __MODULE__.{Participant, Vote}
+  alias LiquidVoting.{Delegations, Repo}
   alias LiquidVoting.Delegations.Delegation
 
   @doc """
@@ -24,31 +25,42 @@ defmodule LiquidVoting.Voting do
 
   """
   def create_vote(attrs \\ %{}) do
-    Repo.transaction(fn ->
-      # TODO: refactor case statements into small functions.
+    Tracer.with_span "#{__MODULE__} #{inspect(__ENV__.function)}" do
+      Tracer.set_attributes([
+        {:request_id, Logger.metadata()[:request_id]},
+        {:params,
+         [
+           {:organization_id, attrs[:organization_id]},
+           {:participant_email, attrs[:participant_email]},
+           {:proposal_url, attrs[:proposal_url]},
+           {:yes, attrs[:yes]}
+         ]}
+      ])
 
-      %Vote{}
-      |> Vote.changeset(attrs)
-      |> Repo.insert()
-      |> case do
-        {:ok, vote} ->
-          if delegation =
-               Repo.get_by(Delegation,
-                 delegator_id: attrs[:participant_id],
-                 organization_id: attrs[:organization_id]
-               ) do
-            case Delegations.delete_delegation(delegation) do
-              {:ok, _delegation} -> vote
-              {:error, changeset} -> Repo.rollback(changeset)
+      Repo.transaction(fn ->
+        %Vote{}
+        |> Vote.changeset(attrs)
+        |> Repo.insert()
+        |> case do
+          {:ok, vote} ->
+            if delegation =
+                 Repo.get_by(Delegation,
+                   delegator_id: attrs[:participant_id],
+                   organization_id: attrs[:organization_id]
+                 ) do
+              case Delegations.delete_delegation(delegation) do
+                {:ok, _delegation} -> vote
+                {:error, changeset} -> Repo.rollback(changeset)
+              end
+            else
+              vote
             end
-          else
-            vote
-          end
-
-        {:error, changeset} ->
-          Repo.rollback(changeset)
-      end
-    end)
+
+          {:error, changeset} ->
+            Repo.rollback(changeset)
+        end
+      end)
+    end
   end
 
   @doc """
@@ -61,11 +73,10 @@ defmodule LiquidVoting.Voting do
 
   """
   def list_votes(organization_id) do
-    Tracer.with_span "LV/voting" do
+    Tracer.with_span "#{__MODULE__} #{inspect(__ENV__.function)}" do
       Tracer.set_attributes([
-        {:action, "list_votes"},
         {:request_id, Logger.metadata()[:request_id]},
-        {:organization_id, organization_id}
+        {:params, [{:organization_id, organization_id}]}
       ])
 
       Vote

lib/liquid_voting_web/resolvers/voting.ex

@@ -28,11 +28,10 @@ defmodule LiquidVotingWeb.Resolvers.Voting do
     do: {:ok, Voting.list_votes_by_proposal(proposal_url, organization_id)}
 
   def votes(_, _, %{context: %{organization_id: organization_id}}) do
-    Tracer.with_span "resolvers/voting" do
+    Tracer.with_span "#{__MODULE__} #{inspect(__ENV__.function)}" do
       Tracer.set_attributes([
-        {:action, "votes"},
         {:request_id, Logger.metadata()[:request_id]},
-        {:organization_id, organization_id}
+        {:params, [{:organization_id, organization_id}]}
       ])
 
       {:ok, Voting.list_votes(organization_id)}
@@ -45,17 +44,28 @@ defmodule LiquidVotingWeb.Resolvers.Voting do
   def create_vote(_, %{participant_email: email, proposal_url: _, yes: _} = args, %{
         context: %{organization_id: organization_id}
       }) do
-    case Voting.upsert_participant(%{email: email, organization_id: organization_id}) do
-      {:error, changeset} ->
-        {:error,
-         message: "Could not create vote with given email",
-         details: ChangesetErrors.error_details(changeset)}
+    Tracer.with_span "#{__MODULE__} #{inspect(__ENV__.function)}" do
+      Tracer.set_attributes([
+        {:request_id, Logger.metadata()[:request_id]},
+        {:params,
+         [
+           {:organization_id, organization_id},
+           {:email, email}
+         ]}
+      ])
 
-      {:ok, participant} ->
-        args
-        |> Map.put(:organization_id, organization_id)
-        |> Map.put(:participant_id, participant.id)
-        |> create_vote_with_valid_arguments()
+      case Voting.upsert_participant(%{email: email, organization_id: organization_id}) do
+        {:error, changeset} ->
+          {:error,
+           message: "Could not create vote with given email",
+           details: ChangesetErrors.error_details(changeset)}
+
+        {:ok, participant} ->
+          args
+          |> Map.put(:organization_id, organization_id)
+          |> Map.put(:participant_id, participant.id)
+          |> create_vote_with_valid_arguments()
+      end
     end
   end