Support :all in Sentry.LoggerBackend's :metadata

CHANGELOG.md

@@ -17,6 +17,7 @@
 ### Improvements
 
 - Make the `Sentry.HTTPClient.child_spec/0` callback optional
+- Add `:all` as a possible value of the `:metadata` configuration option for `Sentry.LoggerBackend`
 
 ## 8.1.0
 

lib/sentry/logger_backend.ex

@@ -22,10 +22,11 @@ defmodule Sentry.LoggerBackend do
   * `:metadata` - To include non-Sentry Logger metadata in reports, the
   `:metadata` key can be set to a list of keys. Metadata under those keys will
   be added in the `:extra` context under the `:logger_metadata` key. Defaults
-  to `[]`.
+  to `[]`. If set to `:all`, all metadata will be included. `:all` is available
+  since v9.0.0 of this library.
 
-  * `:level` - The minimum [Logger level](https://hexdocs.pm/logger/Logger.html#module-levels) to send events for.
-  Defaults to `:error`.
+  * `:level` - The minimum [Logger level](https://hexdocs.pm/logger/Logger.html#module-levels
+    to send events for. Defaults to `:error`.
 
   * `:capture_log_messages` - When `true`, this module will send all Logger
   messages. Defaults to `false`, which will only send messages with metadata
@@ -42,6 +43,7 @@ defmodule Sentry.LoggerBackend do
         metadata: [:foo_bar],
         # Send messages like `Logger.error("error")` to Sentry
         capture_log_messages: true
+
   """
 
   @behaviour :gen_event
@@ -167,6 +169,10 @@ defmodule Sentry.LoggerBackend do
 
   defp excluded_domain?(_, _), do: false
 
+  defp logger_metadata(meta, %__MODULE__{metadata: :all}) do
+    Map.new(meta)
+  end
+
   defp logger_metadata(meta, state) do
     for key <- state.metadata,
         value = meta[key],

test/logger_backend_test.exs

@@ -177,6 +177,28 @@ defmodule Sentry.LoggerBackendTest do
     assert event.extra.logger_metadata == %{}
   end
 
+  test "supports :all for Logger metadata" do
+    Logger.configure_backend(Sentry.LoggerBackend, metadata: :all)
+    ref = expect_sender_call()
+
+    pid = start_supervised!(TestGenServer)
+    Sentry.TestGenServer.add_logger_metadata(pid, :string, "string")
+    Sentry.TestGenServer.invalid_function(pid)
+
+    assert_receive {^ref, event}
+
+    assert event.extra.logger_metadata.string == "string"
+    assert event.extra.logger_metadata.domain == [:otp]
+    assert event.extra.logger_metadata.module == :gen_server
+    assert event.extra.logger_metadata.file == "gen_server.erl"
+    assert is_integer(event.extra.logger_metadata.time)
+    assert is_pid(event.extra.logger_metadata.pid)
+    assert {%FunctionClauseError{}, _stacktrace} = event.extra.logger_metadata.crash_reason
+
+    # Make sure that all this stuff is serializable.
+    assert Sentry.Client.render_event(event).extra.logger_metadata.pid =~ "#PID<"
+  end
+
   test "sends all messages if :capture_log_messages is true" do
     Logger.configure_backend(Sentry.LoggerBackend, capture_log_messages: true)