Formatter config can be a map (#123)

* Formatter config can be a map * Update docs to use maps as formatter config
Nebo15 · Jul 26, 2024 · 222e612 · 222e612
1 parent a43bcd3
commit 222e612
Show file tree

Hide file tree

Showing 6 changed files with 7 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -71,7 +71,7 @@ config :logger, :default_handler,
 or during runtime:
 
 ```elixir
-:logger.update_handler_config(:default, :formatter, {Basic, metadata: {:all_except, [:conn]}})
+:logger.update_handler_config(:default, :formatter, {Basic, %{metadata: {:all_except, [:conn]}}})
 ```
 
 ## Docs

diff --git a/lib/logger_json.ex b/lib/logger_json.ex
@@ -38,7 +38,7 @@ defmodule LoggerJSON do
 
   or during runtime (eg. in your `application.ex`):
 
-      :logger.update_handler_config(:default, :formatter, {Basic, []})
+      :logger.update_handler_config(:default, :formatter, {Basic, %{}})
 
   ## Configuration
 
@@ -50,7 +50,7 @@ defmodule LoggerJSON do
 
   or during runtime:
 
-      :logger.update_handler_config(:default, :formatter, {Basic, metadata: {:all_except, [:conn]}})
+      :logger.update_handler_config(:default, :formatter, {Basic, %{metadata: {:all_except, [:conn]}}})
 
   ### Shared Options
 

diff --git a/lib/logger_json/formatters/basic.ex b/lib/logger_json/formatters/basic.ex
@@ -26,6 +26,7 @@ defmodule LoggerJSON.Formatters.Basic do
 
   @impl true
   def format(%{level: level, meta: meta, msg: msg}, opts) do
+    opts = Keyword.new(opts)
     metadata_keys_or_selector = Keyword.get(opts, :metadata, [])
     metadata_selector = update_metadata_selector(metadata_keys_or_selector, @processed_metadata_keys)
     redactors = Keyword.get(opts, :redactors, [])

diff --git a/lib/logger_json/formatters/datadog.ex b/lib/logger_json/formatters/datadog.ex
@@ -50,6 +50,7 @@ defmodule LoggerJSON.Formatters.Datadog do
 
   @impl true
   def format(%{level: level, meta: meta, msg: msg}, opts) do
+    opts = Keyword.new(opts)
     redactors = Keyword.get(opts, :redactors, [])
     hostname = Keyword.get(opts, :hostname, :system)
 

diff --git a/lib/logger_json/formatters/elastic.ex b/lib/logger_json/formatters/elastic.ex
@@ -143,6 +143,7 @@ defmodule LoggerJSON.Formatters.Elastic do
 
   @impl LoggerJSON.Formatter
   def format(%{level: level, meta: meta, msg: msg}, opts) do
+    opts = Keyword.new(opts)
     metadata_keys_or_selector = Keyword.get(opts, :metadata, [])
     metadata_selector = update_metadata_selector(metadata_keys_or_selector, @processed_metadata_keys)
     redactors = Keyword.get(opts, :redactors, [])

diff --git a/lib/logger_json/formatters/google_cloud.ex b/lib/logger_json/formatters/google_cloud.ex
@@ -100,6 +100,7 @@ defmodule LoggerJSON.Formatters.GoogleCloud do
 
   @impl true
   def format(%{level: level, meta: meta, msg: msg}, opts) do
+    opts = Keyword.new(opts)
     redactors = Keyword.get(opts, :redactors, [])
     service_context = Keyword.get_lazy(opts, :service_context, fn -> %{service: to_string(node())} end)
     project_id = Keyword.get(opts, :project_id)