[logger] Add API function for configuring logger proxy

1 files changed, 59 insertions, 2 deletions

diff --git a/lib/kernel/doc/src/logger.xml b/lib/kernel/doc/src/logger.xml
index e09c5db5e3..0668676096 100644
--- a/lib/kernel/doc/src/logger.xml
+++ b/lib/kernel/doc/src/logger.xml
@@ -245,6 +245,12 @@ logger:error("error happened because: ~p", [Reason]). % Without macro
       </desc>
     </datatype>
     <datatype>
+      <name name="olp_config"/>
+      <desc>
+	<p></p>
+      </desc>
+    </datatype>
+    <datatype>
       <name name="primary_config"/>
       <desc>
 	<p>Primary configuration data for Logger. The following
@@ -597,8 +603,8 @@ start(_, []) ->
       <name name="get_config" arity="0" since="OTP 21.0"/>
       <fsummary>Look up the current Logger configuration</fsummary>
       <desc>
-        <p>Look up all current Logger configuration, including primary
-          and handler configuration, and module level settings.</p>
+        <p>Look up all current Logger configuration, including primary,
+          handler, and proxy configuration, and module level settings.</p>
       </desc>
     </func>
 
@@ -636,6 +642,17 @@ start(_, []) ->
     </func>
 
     <func>
+      <name name="get_proxy_config" arity="0" since="OTP 21.3"/>
+      <fsummary>Look up the current configuration for the Logger proxy.</fsummary>
+      <desc>
+        <p>Look up the current configuration for the Logger proxy.</p>
+	<p>For more information about the proxy, see
+	  section <seealso marker="logger_chapter#proxy">Logger
+	  Proxy</seealso> in the Kernel User's Guide.</p>
+      </desc>
+    </func>
+
+    <func>
       <name name="get_module_level" arity="0" since="OTP 21.0"/>
       <fsummary>Look up all current module levels.</fsummary>
       <desc>
@@ -801,6 +818,27 @@ start(_, []) ->
     </func>
 
     <func>
+      <name name="set_proxy_config" arity="1" since="OTP 21.3"/>
+      <fsummary>Set configuration data for the Logger proxy.</fsummary>
+      <desc>
+        <p>Set configuration data for the Logger proxy. This
+          overwrites the current proxy configuration. Keys that are not
+          specified in the <c><anno>Config</anno></c> map gets default
+          values.</p>
+	<p>To modify the existing configuration,
+	  use <seealso marker="#update_proxy_config-1">
+	    <c>update_proxy_config/1</c></seealso>, or, if a more
+	  complex merge is needed, read the current configuration
+	  with <seealso marker="#get_proxy_config-0"><c>get_proxy_config/0</c>
+	  </seealso>, then do the merge before writing the new
+	  configuration back with this function.</p>
+	<p>For more information about the proxy, see
+	  section <seealso marker="logger_chapter#proxy">Logger
+	  Proxy</seealso> in the Kernel User's Guide.</p>
+      </desc>
+    </func>
+
+    <func>
       <name name="set_module_level" arity="2" since="OTP 21.0"/>
       <fsummary>Set the log level for the specified modules.</fsummary>
       <desc>
@@ -1013,6 +1051,25 @@ logger:set_process_metadata(maps:merge(logger:get_process_metadata(), Meta)).
 	  </seealso>.</p>
       </desc>
     </func>
+
+    <func>
+      <name name="update_proxy_config" arity="1" since="OTP 21.3"/>
+      <fsummary>Update configuration data for the Logger proxy.</fsummary>
+      <desc>
+        <p>Update configuration data for the Logger proxy. This function
+          behaves as if it was implemented as follows:</p>
+	<code type="erl">
+Old = logger:get_proxy_config(),
+logger:set_proxy_config(maps:merge(Old, Config)).
+	</code>
+	<p>To overwrite the existing configuration without any merge,
+	  use <seealso marker="#set_proxy_config-1"><c>set_proxy_config/1</c>
+	  </seealso>.</p>
+	<p>For more information about the proxy, see
+	  section <seealso marker="logger_chapter#proxy">Logger
+	  Proxy</seealso> in the Kernel User's Guide.</p>
+      </desc>
+    </func>
   </funcs>
 
   <section>