Skip to content

Commit e1b16a6

Browse files
committed
Add the default logging format to the docs.
1 parent 39d3f15 commit e1b16a6

File tree

1 file changed

+80
-80
lines changed

1 file changed

+80
-80
lines changed

docs/source/manual/configuration.rst

Lines changed: 80 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -605,33 +605,33 @@ Console
605605
discardingThreshold: 0
606606
timeZone: UTC
607607
target: stdout
608-
logFormat: # TODO
608+
logFormat: "%-5p [%d{ISO8601,UTC}] %c: %m%n%rEx"
609609
filterFactories:
610610
- type: URI
611611
612612
613-
====================== =========== ===========
614-
Name Default Description
615-
====================== =========== ===========
616-
type REQUIRED The appender type. Must be ``console``.
617-
threshold ALL The lowest level of events to print to the console.
618-
queueSize 256 The maximum capacity of the blocking queue.
619-
discardingThreshold 51 When the blocking queue has only the capacity mentioned in
620-
discardingThreshold remaining, it will drop events of level TRACE,
621-
DEBUG and INFO, keeping only events of level WARN and ERROR.
622-
If no discarding threshold is specified, then a default of queueSize / 5 is used.
623-
To keep all events, set discardingThreshold to 0.
624-
timeZone UTC The time zone to which event timestamps will be converted.
625-
To use the system/default time zone, set it to ``system``.
626-
target stdout The name of the standard stream to which events will be written.
627-
Can be ``stdout`` or ``stderr``.
628-
logFormat default The Logback pattern with which events will be formatted. See
629-
the Logback_ documentation for details.
630-
filterFactories (none) The list of filters to apply to the appender, in order, after
631-
the thresold.
632-
neverBlock false Prevent the wrapping asynchronous appender from blocking when its underlying queue is full.
633-
Set to true to disable blocking.
634-
====================== =========== ===========
613+
====================== ======================================= ===========
614+
Name Default Description
615+
====================== ======================================= ===========
616+
type REQUIRED The appender type. Must be ``console``.
617+
threshold ALL The lowest level of events to print to the console.
618+
queueSize 256 The maximum capacity of the blocking queue.
619+
discardingThreshold 51 When the blocking queue has only the capacity mentioned in
620+
discardingThreshold remaining, it will drop events of level TRACE,
621+
DEBUG and INFO, keeping only events of level WARN and ERROR.
622+
If no discarding threshold is specified, then a default of queueSize / 5 is used.
623+
To keep all events, set discardingThreshold to 0.
624+
timeZone UTC The time zone to which event timestamps will be converted.
625+
To use the system/default time zone, set it to ``system``.
626+
target stdout The name of the standard stream to which events will be written.
627+
Can be ``stdout`` or ``stderr``.
628+
logFormat %-5p [%d{ISO8601,UTC}] %c: %m%n%rEx The Logback pattern with which events will be formatted. See
629+
the Logback_ documentation for details.
630+
filterFactories (none) The list of filters to apply to the appender, in order, after
631+
the threshold.
632+
neverBlock false Prevent the wrapping asynchronous appender from blocking when its underlying queue is full.
633+
Set to true to disable blocking.
634+
====================== ======================================= ===========
635635

636636
.. _Logback: http://logback.qos.ch/manual/layouts.html#conversionWord
637637

@@ -655,47 +655,47 @@ File
655655
archivedLogFilenamePattern: /var/log/myapplication-%d.log
656656
archivedFileCount: 5
657657
timeZone: UTC
658-
logFormat: # TODO
658+
logFormat: "%-5p [%d{ISO8601,UTC}] %c: %m%n%rEx"
659659
bufferSize: 8KB
660660
filterFactories:
661661
- type: URI
662662
663663
664-
============================ =========== ==================================================================================================
665-
Name Default Description
666-
============================ =========== ==================================================================================================
667-
type REQUIRED The appender type. Must be ``file``.
668-
currentLogFilename REQUIRED The filename where current events are logged.
669-
threshold ALL The lowest level of events to write to the file.
670-
queueSize 256 The maximum capacity of the blocking queue.
671-
discardingThreshold 51 When the blocking queue has only the capacity mentioned in discardingThreshold
672-
remaining, it will drop events of level TRACE, DEBUG and INFO, keeping only events
673-
of level WARN and ERROR. If no discarding threshold is specified, then a default
674-
of queueSize / 5 is used. To keep all events, set discardingThreshold to 0.
675-
archive true Whether or not to archive old events in separate files.
676-
archivedLogFilenamePattern (none) Required if ``archive`` is ``true``.
677-
The filename pattern for archived files.
678-
If ``maxFileSize`` is specified, rollover is size-based, and the pattern must contain ``%i`` for
679-
an integer index of the archived file.
680-
Otherwise rollover is date-based, and the pattern must contain ``%d``, which is replaced with the
681-
date in ``yyyy-MM-dd`` form.
682-
If the pattern ends with ``.gz`` or ``.zip``, files will be compressed as they are archived.
683-
archivedFileCount 5 The number of archived files to keep. Must be greater than or equal to ``0``. Zero is a
684-
special value signifying to keep infinite logs (use with caution)
685-
maxFileSize (unlimited) The maximum size of the currently active file before a rollover is triggered. The value can be
686-
expressed in bytes, kilobytes, megabytes, gigabytes, and terabytes by appending B, K, MB, GB, or
687-
TB to the numeric value. Examples include 100MB, 1GB, 1TB. Sizes can also be spelled out, such
688-
as 100 megabytes, 1 gigabyte, 1 terabyte.
689-
timeZone UTC The time zone to which event timestamps will be converted.
690-
logFormat default The Logback pattern with which events will be formatted. See
691-
the Logback_ documentation for details.
692-
filterFactories (none) The list of filters to apply to the appender, in order, after
693-
the thresold.
694-
neverBlock false Prevent the wrapping asynchronous appender from blocking when its underlying queue is full.
695-
Set to true to disable blocking.
696-
bufferSize 8KB The buffer size of the underlying FileAppender (setting added in logback 1.1.10). Increasing this
697-
from the default of 8KB to 256KB is reported to significantly reduce thread contention.
698-
============================ =========== ==================================================================================================
664+
============================ ========================================= ==================================================================================================
665+
Name Default Description
666+
============================ ========================================= ==================================================================================================
667+
type REQUIRED The appender type. Must be ``file``.
668+
currentLogFilename REQUIRED The filename where current events are logged.
669+
threshold ALL The lowest level of events to write to the file.
670+
queueSize 256 The maximum capacity of the blocking queue.
671+
discardingThreshold 51 When the blocking queue has only the capacity mentioned in discardingThreshold
672+
remaining, it will drop events of level TRACE, DEBUG and INFO, keeping only events
673+
of level WARN and ERROR. If no discarding threshold is specified, then a default
674+
of queueSize / 5 is used. To keep all events, set discardingThreshold to 0.
675+
archive true Whether or not to archive old events in separate files.
676+
archivedLogFilenamePattern (none) Required if ``archive`` is ``true``.
677+
The filename pattern for archived files.
678+
If ``maxFileSize`` is specified, rollover is size-based, and the pattern must contain ``%i`` for
679+
an integer index of the archived file.
680+
Otherwise rollover is date-based, and the pattern must contain ``%d``, which is replaced with the
681+
date in ``yyyy-MM-dd`` form.
682+
If the pattern ends with ``.gz`` or ``.zip``, files will be compressed as they are archived.
683+
archivedFileCount 5 The number of archived files to keep. Must be greater than or equal to ``0``. Zero is a
684+
special value signifying to keep infinite logs (use with caution)
685+
maxFileSize (unlimited) The maximum size of the currently active file before a rollover is triggered. The value can be
686+
expressed in bytes, kilobytes, megabytes, gigabytes, and terabytes by appending B, K, MB, GB, or
687+
TB to the numeric value. Examples include 100MB, 1GB, 1TB. Sizes can also be spelled out, such
688+
as 100 megabytes, 1 gigabyte, 1 terabyte.
689+
timeZone UTC The time zone to which event timestamps will be converted.
690+
logFormat %-5p [%d{ISO8601,UTC}] %c: %m%n%rEx The Logback pattern with which events will be formatted. See
691+
the Logback_ documentation for details.
692+
filterFactories (none) The list of filters to apply to the appender, in order, after
693+
the threshold.
694+
neverBlock false Prevent the wrapping asynchronous appender from blocking when its underlying queue is full.
695+
Set to true to disable blocking.
696+
bufferSize 8KB The buffer size of the underlying FileAppender (setting added in logback 1.1.10). Increasing this
697+
from the default of 8KB to 256KB is reported to significantly reduce thread contention.
698+
============================ ========================================= ==================================================================================================
699699

700700

701701
.. _man-configuration-logging-syslog:
@@ -714,31 +714,31 @@ Syslog
714714
facility: local0
715715
threshold: ALL
716716
stackTracePrefix: \t
717-
logFormat: # TODO
717+
logFormat: "%-5p [%d{ISO8601,UTC}] %c: %m%n%rEx"
718718
filterFactories:
719719
- type: URI
720720
721721
722-
============================ =========== ==================================================================================================
723-
Name Default Description
724-
============================ =========== ==================================================================================================
725-
host localhost The hostname of the syslog server.
726-
port 514 The port on which the syslog server is listening.
727-
facility local0 The syslog facility to use. Can be either ``auth``, ``authpriv``,
728-
``daemon``, ``cron``, ``ftp``, ``lpr``, ``kern``, ``mail``,
729-
``news``, ``syslog``, ``user``, ``uucp``, ``local0``,
730-
``local1``, ``local2``, ``local3``, ``local4``, ``local5``,
731-
``local6``, or ``local7``.
732-
threshold ALL The lowest level of events to write to the file.
733-
logFormat default The Logback pattern with which events will be formatted. See
734-
the Logback_ documentation for details.
735-
stackTracePrefix \t The prefix to use when writing stack trace lines (these are sent
736-
to the syslog server separately from the main message)
737-
filterFactories (none) The list of filters to apply to the appender, in order, after
738-
the thresold.
739-
neverBlock false Prevent the wrapping asynchronous appender from blocking when its underlying queue is full.
740-
Set to true to disable blocking.
741-
============================ =========== ==================================================================================================
722+
============================ ===================================== ==================================================================================================
723+
Name Default Description
724+
============================ ===================================== ==================================================================================================
725+
host localhost The hostname of the syslog server.
726+
port 514 The port on which the syslog server is listening.
727+
facility local0 The syslog facility to use. Can be either ``auth``, ``authpriv``,
728+
``daemon``, ``cron``, ``ftp``, ``lpr``, ``kern``, ``mail``,
729+
``news``, ``syslog``, ``user``, ``uucp``, ``local0``,
730+
``local1``, ``local2``, ``local3``, ``local4``, ``local5``,
731+
``local6``, or ``local7``.
732+
threshold ALL The lowest level of events to write to the file.
733+
logFormat %-5p [%d{ISO8601,UTC}] %c: %m%n%rEx The Logback pattern with which events will be formatted. See
734+
the Logback_ documentation for details.
735+
stackTracePrefix \t The prefix to use when writing stack trace lines (these are sent
736+
to the syslog server separately from the main message)
737+
filterFactories (none) The list of filters to apply to the appender, in order, after
738+
the threshold.
739+
neverBlock false Prevent the wrapping asynchronous appender from blocking when its underlying queue is full.
740+
Set to true to disable blocking.
741+
============================ ===================================== ==================================================================================================
742742

743743

744744
.. _man-configuration-logging-filter-factories:

0 commit comments

Comments
 (0)