better error logging

Author: mitchellhenke

lib/sentry/client.ex

@@ -48,7 +48,7 @@ defmodule Sentry.Client do
     end
   end
 
-  defp request(method, url, headers, body) do
+  def request(method, url, headers, body) do
     case :hackney.request(method, url, headers, body, []) do
       {:ok, 200, _headers, client} ->
         case :hackney.body(client) do
@@ -61,6 +61,10 @@ defmodule Sentry.Client do
             log_api_error(body)
             :error
         end
+      {:ok, status, headers, client} ->
+        error_header = :proplists.get_value("X-Sentry-Error", headers, "")
+        log_api_error("#{body}\nReceived #{status} from Sentry server: #{error_header}")
+        :error
       _ ->
         log_api_error(body)
         :error

test/client_test.exs

@@ -1,5 +1,7 @@
 defmodule Sentry.ClientTest do
-  use ExUnit.Case, async: true
+  use ExUnit.Case
+  import ExUnit.CaptureLog
+
   alias Sentry.Client
   @sentry_dsn "https://public:[email protected]/1"
 
@@ -8,11 +10,33 @@ defmodule Sentry.ClientTest do
     assert Client.authorization_header(public_key, private_key) =~ ~r/Sentry sentry_version=5, sentry_client=sentry-elixir\/#{Application.spec(:sentry, :vsn)}, sentry_timestamp=\d{10}, sentry_key=public, sentry_secret=secret/
   end
 
-  test "parning dsn" do
+  test "parsing dsn" do
     assert {"https://app.getsentry.com:443/api/1/store/", "public", "secret"} =
       Sentry.Client.parse_dsn!("https://public:[email protected]/1")
 
     assert {"http://app.getsentry.com:9000/api/1/store/", "public", "secret"} =
       Sentry.Client.parse_dsn!("http://public:[email protected]:9000/1")
   end
+
+  test "logs api errors" do
+    bypass = Bypass.open
+    Bypass.expect bypass, fn conn ->
+      {:ok, _body, conn} = Plug.Conn.read_body(conn)
+      assert conn.request_path == "/api/1/store/"
+      assert conn.method == "POST"
+      Plug.Conn.put_resp_header(conn, "X-Sentry-Error", "Creation of this event was denied due to rate limiting.")
+      |> Plug.Conn.resp(400, "Something bad happened")
+    end
+
+    Application.put_env(:sentry, :dsn, "http://public:secret@localhost:#{bypass.port}/1")
+
+      try do
+        Event.not_a_function
+      rescue
+        e ->
+        assert capture_log(fn ->
+          Sentry.capture_exception(e)
+        end) =~ ~r/400.*Creation of this event was denied due to rate limiting/
+      end
+  end
 end

test/logger_test.exs

@@ -15,7 +15,6 @@ defmodule Sentry.LoggerTest do
     end
 
     Application.put_env(:sentry, :dsn, "http://public:secret@localhost:#{bypass.port}/1")
-    Application.put_env(:sentry, :included_environments, [:test])
     :error_logger.add_report_handler(Sentry.Logger)
 
     capture_log fn ->

test/support/test_client.ex

@@ -2,6 +2,6 @@ defmodule Sentry.TestClient do
   def send_event(%Sentry.Event{} = event) do
     {endpoint, _public_key, _secret_key} = Sentry.Client.parse_dsn!(Application.fetch_env!(:sentry, :dsn))
     body = Poison.encode!(event)
-    :hackney.request(:post, endpoint, [], body, [])
+    Sentry.Client.request(:post, endpoint, [], body)
   end
 end