Skip to content

Commit c059ba0

Browse files
committed
[FAB-4931] Update doc for core.yaml logging section
This CR updates the comments for the logging section of core.yaml to accurately document the usage of the available environment variables. Change-Id: Ib042b9af1deb925d8fa30b870b7c774906909564 Signed-off-by: Will Lahti <[email protected]>
1 parent 0dc9234 commit c059ba0

File tree

1 file changed

+20
-5
lines changed

1 file changed

+20
-5
lines changed

sampleconfig/core.yaml

+20-5
Original file line numberDiff line numberDiff line change
@@ -16,21 +16,36 @@ logging:
1616

1717
# CRITICAL | ERROR | WARNING | NOTICE | INFO | DEBUG
1818

19-
# The logging levels specified here can be overridden in various ways,
19+
# The overall default logging level can be specified in various ways,
2020
# listed below from strongest to weakest:
2121
#
2222
# 1. The --logging-level=<level> command line option overrides all other
23-
# specifications.
23+
# default specifications.
2424
#
2525
# 2. The environment variable CORE_LOGGING_LEVEL otherwise applies to
2626
# all peer commands if defined as a non-empty string.
2727
#
28-
# 3. Otherwise, the specifications below apply.
28+
# 3. The value of peer that directly follows in this file. It can also
29+
# be set via the environment variable CORE_LOGGING_PEER.
30+
#
31+
# If no overall default level is provided via any of the above methods,
32+
# the peer will default to INFO (the value of defaultLevel in
33+
# common/flogging/logging.go)
2934

30-
# Default for all modules running within the scope of a peer
35+
# Default for all modules running within the scope of a peer.
36+
# Note: this value is only used when --logging-level or CORE_LOGGING_LEVEL
37+
# are not set
3138
peer: info
3239

33-
# Override levels for various 'peer' modules
40+
# The overall default values mentioned above can be overridden for the
41+
# specific components listed in the override section below.
42+
43+
# Override levels for various peer modules. These levels will be
44+
# applied once the peer has completely started. They are applied at this
45+
# time in order to be sure every logger has been registered with the
46+
# logging package.
47+
# Note: the modules listed below are the only acceptable modules at this
48+
# time.
3449
cauthdsl: warning
3550
gossip: warning
3651
ledger: info

0 commit comments

Comments
 (0)