java.lang.Object | |||
↳ | org.apache.log4j.Layout | ||
↳ | org.apache.log4j.helpers.DateLayout | ||
↳ | org.apache.log4j.TTCCLayout |
TTCC layout format consists of time, thread, category and nested diagnostic context information, hence the name.
Each of the four fields can be individually enabled or
disabled. The time format depends on the DateFormat
used.
Here is an example TTCCLayout output with the
RelativeTimeDateFormat
.
176 [main] INFO org.apache.log4j.examples.Sort - Populating an array of 2 elements in reverse order. 225 [main] INFO org.apache.log4j.examples.SortAlgo - Entered the sort method. 262 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=1 - Outer loop. 276 [main] DEBUG org.apache.log4j.examples.SortAlgo.SWAP i=1 j=0 - Swapping intArray[0] = 1 and intArray[1] = 0 290 [main] DEBUG org.apache.log4j.examples.SortAlgo.OUTER i=0 - Outer loop. 304 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Dump of interger array: 317 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Element [0] = 0 331 [main] INFO org.apache.log4j.examples.SortAlgo.DUMP - Element [1] = 1 343 [main] INFO org.apache.log4j.examples.Sort - The next log statement should be an error message. 346 [main] ERROR org.apache.log4j.examples.SortAlgo.DUMP - Tried to dump an uninitialized array. at org.apache.log4j.examples.SortAlgo.dump(SortAlgo.java:58) at org.apache.log4j.examples.Sort.main(Sort.java:64) 467 [main] INFO org.apache.log4j.examples.Sort - Exiting main method.
The first field is the number of milliseconds elapsed since the start of the program. The second field is the thread outputting the log statement. The third field is the level, the fourth field is the category to which the statement belongs.
The fifth field (just before the '-') is the nested diagnostic context. Note the nested diagnostic context may be empty as in the first two statements. The text after the '-' is the message of the statement.
WARNING Do not use the same TTCCLayout instance from within different appenders. The TTCCLayout is not thread safe when used in his way. However, it is perfectly safe to use a TTCCLayout instance from just one appender.
PatternLayout
offers a much more flexible alternative.
[Expand]
Inherited Constants | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.log4j.helpers.DateLayout
|
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
buf |
[Expand]
Inherited Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.log4j.helpers.DateLayout
| |||||||||||
From class
org.apache.log4j.Layout
|
Public Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Instantiate a TTCCLayout object with
RelativeTimeDateFormat as the date
formatter in the local time zone. | |||||||||||
Instantiate a TTCCLayout object using the local time zone.
|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
In addition to the level of the statement and message, the
returned byte array includes time, thread, category and
NDC
information. | |||||||||||
Returns value of the CategoryPrefixing option.
| |||||||||||
Returns value of the ContextPrinting option.
| |||||||||||
Returns value of the ThreadPrinting option.
| |||||||||||
The TTCCLayout does not handle the throwable contained within
LoggingEvents . | |||||||||||
The CategoryPrefixing option specifies whether
Category
name is part of log output or not. | |||||||||||
The ContextPrinting option specifies log output will include
the nested context information belonging to the current thread.
| |||||||||||
The ThreadPrinting option specifies whether the name of the
current thread is part of log output or not.
|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
org.apache.log4j.helpers.DateLayout
| |||||||||||
From class
org.apache.log4j.Layout
| |||||||||||
From class
java.lang.Object
| |||||||||||
From interface
org.apache.log4j.spi.OptionHandler
|
Instantiate a TTCCLayout object with RelativeTimeDateFormat
as the date
formatter in the local time zone.
Instantiate a TTCCLayout object using the local time zone. The
DateFormat used will depend on the dateFormatType
.
This constructor just calls the setDateFormat(String)
method.
In addition to the level of the statement and message, the
returned byte array includes time, thread, category and NDC
information.
Time, thread, category and diagnostic context are printed depending on options.
event | The event to format |
---|
Returns value of the CategoryPrefixing option.
Returns value of the ContextPrinting option.
Returns value of the ThreadPrinting option.
The TTCCLayout does not handle the throwable contained within
LoggingEvents
. Thus, it returns
true
.
The CategoryPrefixing option specifies whether Category
name is part of log output or not. This is true by default.
The ContextPrinting option specifies log output will include the nested context information belonging to the current thread. This is true by default.
The ThreadPrinting option specifies whether the name of the current thread is part of log output or not. This is true by default.