Merge pull request #224 from getsentry/json-event

Event Struct Rendering

Author: mitchellhenke

lib/sentry/client.ex

@@ -71,7 +71,9 @@ defmodule Sentry.Client do
   end
 
   defp encode_and_send(event, result) do
-    case Poison.encode(event) do
+    render_event(event)
+    |> Poison.encode()
+    |> case do
       {:ok, body} ->
         do_send_event(event, body, result)
       {:error, error} ->
@@ -216,6 +218,42 @@ defmodule Sentry.Client do
     @hackney_pool_name
   end
 
+  @doc """
+  Transform the Event struct into JSON map.
+
+  Most Event attributes map directly to JSON map, with stacktrace being the
+  exception.  If the event does not have stacktrace frames, it should not
+  be included in the JSON body.
+  """
+  def render_event(%Event{} = event) do
+    map =  %{
+      event_id: event.event_id,
+      culprit: event.culprit,
+      timestamp: event.timestamp,
+      message: event.message,
+      tags: event.tags,
+      level: event.level,
+      platform: event.platform,
+      server_name: event.server_name,
+      environment: event.environment,
+      exception: event.exception,
+      release: event.release,
+      request: event.request,
+      extra: event.extra,
+      user: event.user,
+      breadcrumbs: event.breadcrumbs,
+      fingerprint: event.fingerprint,
+      modules: event.modules,
+    }
+
+    case event.stacktrace do
+      %{frames: [_ | _]} ->
+        Map.put(map, :stacktrace, event.stacktrace)
+      _ ->
+        map
+    end
+  end
+
   defp log_api_error(body) do
     Logger.warn(fn ->
       ["Failed to send Sentry event.", ?\n, body]

test/client_test.exs

@@ -63,6 +63,7 @@ defmodule Sentry.ClientTest do
       request_map = Poison.decode!(body)
       assert request_map["extra"] == %{"key" => "value"}
       assert request_map["user"]["id"] == 1
+      assert is_nil(request_map["stacktrace"]["frames"])
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end
 
@@ -163,7 +164,9 @@ defmodule Sentry.ClientTest do
   test "sends event with sample_rate of 1" do
     bypass = Bypass.open
     Bypass.expect bypass, fn conn ->
-      {:ok, _body, conn} = Plug.Conn.read_body(conn)
+      {:ok, body, conn} = Plug.Conn.read_body(conn)
+      request_map = Poison.decode!(body)
+      assert Enum.count(request_map["stacktrace"]["frames"]) > 0
       Plug.Conn.resp(conn, 200, ~s<{"id": "340"}>)
     end
 
@@ -176,7 +179,8 @@ defmodule Sentry.ClientTest do
       Event.not_a_function
     rescue
       e ->
-        {:ok, _} = Sentry.capture_exception(e, result: :sync, sample_rate: 1)
+        {:ok, _} = Sentry.capture_exception(e, stacktrace: System.stacktrace,
+                                            result: :sync, sample_rate: 1)
     end
   end
 

test/support/test_client.exs

@@ -5,7 +5,9 @@ defmodule Sentry.TestClient do
   def send_event(%Sentry.Event{} = event, _opts \\ []) do
     {endpoint, _public_key, _secret_key} = Sentry.Client.get_dsn!
     event = Sentry.Client.maybe_call_before_send_event(event)
-    case Poison.encode(event) do
+    Sentry.Client.render_event(event)
+    |> Poison.encode()
+    |> case do
       {:ok, body} ->
         Sentry.Client.request(:post, endpoint, [], body)
       {:error, error} ->