From d73f47345776d3567b50115af69d551077909514 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Bj=C3=B6rn=20Gustavsson?= Date: Fri, 28 Aug 2015 14:45:56 +0200 Subject: Add documentation --- lib/kernel/doc/src/kernel_app.xml | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) (limited to 'lib/kernel') diff --git a/lib/kernel/doc/src/kernel_app.xml b/lib/kernel/doc/src/kernel_app.xml index 2cea38bae9..956c57f7c1 100644 --- a/lib/kernel/doc/src/kernel_app.xml +++ b/lib/kernel/doc/src/kernel_app.xml @@ -43,6 +43,7 @@ erl_boot_server erl_ddll error_logger + error_logger_format_depth file global global_group @@ -152,6 +153,42 @@ + error_logger_format_depth = Depth + + +

This parameter can be used to limit the size of the + formatted output from the error logger event handlers.

+ +

This configuration parameter was introduced in OTP 18.1. + It is currently experimental. Based on user feedback it + may be changed or improved in future releases, for example + to gain better control over how to limit the size of the + formatted output. We have no plans to entirely remove this + new feature, unless it turns out to be completely + useless. In OTP 19, the default may be changed to limit the + formatted output.

+ +

Depth is a positive integer that is the maximum + depth to which terms are printed by the error logger event + handlers included in OTP. Specifically, the two event handlers + defined by the Kernel application and the two event + handlers in the SASL application will use this + configuration parameter. (If you have implemented you own + error handlers, this configuration parameter will have no + effect on them.)

+ +

The way Depth is used, is that format strings + string passed to the event handlers will be rewritten. + The "~p" and "~w" format controls will be replaced with + "~P" and "~W", respectively, and Depth will be + used as the depth parameter. See + io:format/2.

+ +

A reasonable starting value for Depth is + 30. You should test crashing various processes in your + application and examine the logs from the crashes, and then + either increase or decrease the value.

+
global_groups = [GroupTuple]

Defines global groups, see -- cgit v1.2.3