Merge pull request #182 from getsentry/modules

Modules

Author: mitchellhenke

README.md

@@ -75,6 +75,7 @@ config :sentry,
 | `after_send_event` | False | | |
 | `sample_rate` | False | 1.0 | |
 | `in_app_module_whitelist` | False | `[]` | |
+| `report_deps` | False | True | Will attempt to load Mix dependencies at compile time to report alongside events |
 | `enable_source_code_context` | True | | |
 | `root_source_code_path` | Required if `enable_source_code_context` is enabled | | Should generally be set to `File.cwd!`|
 | `context_lines` | False  | 3 | |

docs/config.rst

@@ -97,6 +97,10 @@ Optional settings
 
   Expects a list of modules that is used to distinguish among stacktrace frames that belong to your app and ones that are part of libraries or core Elixir.  This is used to better display the significant part of stacktraces.  The logic is greedy, so if your app's root module is ``MyApp`` and your setting is ``[MyApp]``, that module as well as any submodules like ``MyApp.Submodule`` would be considered part of your app.  Defaults to ``[]``.
 
+.. describe:: report_deps
+
+  Will attempt to load Mix dependencies at runtime to report alongside events.  Defaults to `true`.
+
 .. describe:: context_lines
 
   The number of lines of source code before and after the line that caused the exception to be included.  Defaults to ``3``.

lib/sentry/config.ex

@@ -101,6 +101,10 @@ defmodule Sentry.Config do
     get_config(:after_send_event, check_dsn: false)
   end
 
+  def report_deps do
+    get_config(:report_deps, default: true, check_dsn: false)
+  end
+
   defp get_config(key, opts \\ []) when is_atom(key) do
     default = Keyword.get(opts, :default)
     check_dsn = Keyword.get(opts, :check_dsn, true)

lib/sentry/event.ex

@@ -7,6 +7,7 @@ defmodule Sentry.Event do
   ### Configuration
 
   * `:in_app_module_whitelist` - Expects a list of modules that is used to distinguish among stacktrace frames that belong to your app and ones that are part of libraries or core Elixir.  This is used to better display the significant part of stacktraces.  The logic is greedy, so if your app's root module is `MyApp` and your setting is `[MyApp]`, that module as well as any submodules like `MyApp.Submodule` would be considered part of your app.  Defaults to `[]`.
+  * `:report_deps` - Flag for whether to include the loaded dependencies when reporting an error. Defaults to true.
 
   """
 
@@ -28,14 +29,18 @@ defmodule Sentry.Event do
             extra: %{},
             user: %{},
             breadcrumbs: [],
-            fingerprint: []
+            fingerprint: [],
+            modules: %{}
 
   @type t :: %__MODULE__{}
 
   alias Sentry.{Event, Util, Config}
   @source_code_context_enabled Application.fetch_env!(:sentry, :enable_source_code_context)
   @source_files if(@source_code_context_enabled, do: Sentry.Sources.load_files(), else: nil)
 
+  @enable_deps_reporting Config.report_deps()
+  @deps if(@enable_deps_reporting, do: Util.mix_deps_to_map(Mix.Dep.loaded([env: Mix.env])), else: %{})
+
   @doc """
   Creates an Event struct out of context collected and options
   ## Options
@@ -102,7 +107,8 @@ defmodule Sentry.Event do
       user: user,
       breadcrumbs: breadcrumbs,
       request: request,
-      fingerprint: fingerprint
+      fingerprint: fingerprint,
+      modules: @deps,
     }
     |> add_metadata()
   end

lib/sentry/util.ex

@@ -21,4 +21,15 @@ defmodule Sentry.Util do
     |> DateTime.to_iso8601()
     |> String.trim_trailing("Z")
   end
+
+  def mix_deps_to_map([%Mix.Dep{} | _rest] = modules) do
+    Enum.reduce(modules, %{}, fn(x, acc) ->
+      case x.status do
+        {:ok, version} -> Map.put(acc, x.app, version)
+        _ -> acc
+      end
+    end)
+  end
+
+  def mix_deps_to_map(modules), do: modules
 end

mix.lock

@@ -6,7 +6,7 @@
   "credo": {:hex, :credo, "0.8.1", "137efcc99b4bc507c958ba9b5dff70149e971250813cbe7d4537ec7e36997402", [:mix], [{:bunt, "~> 0.2.0", [hex: :bunt, optional: false]}]},
   "dialyxir": {:hex, :dialyxir, "0.5.0", "5bc543f9c28ecd51b99cc1a685a3c2a1a93216990347f259406a910cf048d1d7", [:mix], []},
   "earmark": {:hex, :earmark, "1.2.2", "f718159d6b65068e8daeef709ccddae5f7fdc770707d82e7d126f584cd925b74", [:mix], []},
-  "ex_doc": {:hex, :ex_doc, "0.16.1", "b4b8a23602b4ce0e9a5a960a81260d1f7b29635b9652c67e95b0c2f7ccee5e81", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, optional: false]}]},
+  "ex_doc": {:hex, :ex_doc, "0.16.2", "3b3e210ebcd85a7c76b4e73f85c5640c011d2a0b2f06dcdf5acdb2ae904e5084", [:mix], [{:earmark, "~> 1.1", [hex: :earmark, optional: false]}]},
   "hackney": {:hex, :hackney, "1.8.0", "8388a22f4e7eb04d171f2cf0285b217410f266d6c13a4c397a6c22ab823a486c", [:rebar3], [{:certifi, "1.1.0", [hex: :certifi, optional: false]}, {:idna, "4.0.0", [hex: :idna, optional: false]}, {:metrics, "1.0.1", [hex: :metrics, optional: false]}, {:mimerl, "1.0.2", [hex: :mimerl, optional: false]}, {:ssl_verify_fun, "1.1.1", [hex: :ssl_verify_fun, optional: false]}]},
   "idna": {:hex, :idna, "4.0.0", "10aaa9f79d0b12cf0def53038547855b91144f1bfcc0ec73494f38bb7b9c4961", [:rebar3], []},
   "metrics": {:hex, :metrics, "1.0.1", "25f094dea2cda98213cecc3aeff09e940299d950904393b2a29d191c346a8486", [:rebar3], []},

test/event_test.exs

@@ -124,4 +124,15 @@ defmodule Sentry.EventTest do
         },
       ]} == event.stacktrace
   end
+
+  test "transforms mix deps to map of modules" do
+    exception = RuntimeError.exception("error")
+    event = Sentry.Event.transform_exception(exception, [])
+
+    assert event.modules == %{bunt: "0.2.0", bypass: "0.7.0", certifi: "1.1.0", cowboy: "1.1.2",
+      cowlib: "1.0.2", credo: "0.8.1", hackney: "1.8.0", idna: "4.0.0",
+      metrics: "1.0.1", mime: "1.1.0", mimerl: "1.0.2", plug: "1.3.5",
+      poison: "3.1.0", ranch: "1.3.2", ssl_verify_fun: "1.1.1",
+      uuid: "1.1.7"}
+  end
 end