a nested diagnostic context, or ndc in short, is an instrument to distinguish interleaved log output from different sources. log output is typically interleaved when a server handles multiple clients near-simultaneously.
interleaved log output can still be meaningful if each log entry from different contexts had a distinctive stamp. this is where ndcs come into play.
note that ndcs are managed on a per thread basis. ndc operations such as push, pop, clear and getDepth affect the ndc of the current thread only. ndcs of other threads remain unaffected.
for example, a servlet can build a per client request ndc consisting the clients host name and other information contained in the the request. cookies are another source of distinctive information. to build an ndc one uses the push operation. simply put,
ndc.push
. as a side effect, if there is no nested diagnostic context for the current thread, this method will create it.
ndc.pop
.
there is no penalty for forgetting to match each push
operation with a corresponding pop
, except the obvious mismatch between the real application context and the context set in the ndc.
if configured to do so, PatternLayout and TTCCLayout instances automatically retrieve the nested diagnostic context for the current thread without any user intervention. hence, even if a servlet is serving multiple clients simultaneously, the logs emanating from the same code (belonging to the same logger) can still be distinguished because each client request will have a different ndc tag.
heavy duty systems should call the remove method when leaving the run method of a thread. this ensures that the memory used by the thread can be freed by the java garbage collector. there is a mechanism to lazily remove references to dead threads. in practice, this means that you can be a little sloppy and sometimes forget to call remove before exiting a thread.
Public Types | |
typedef std::pair< LogString, LogString > | DiagnosticContext |
Pair of Message and FullMessage. | |
typedef std::stack< DiagnosticContext > | Stack |
Public Member Functions | |
NDC (const std::string &message) | |
Creates a nested diagnostic context. | |
~NDC () | |
Removes the topmost element from the NDC stack. | |
NDC (const std::wstring &message) | |
Creates a nested diagnostic context. | |
NDC (const std::basic_string< UniChar > &message) | |
Creates a nested diagnostic context. | |
NDC (const CFStringRef &message) | |
Creates a nested diagnostic context. | |
Static Public Member Functions | |
static void | clear () |
Clear any nested diagnostic information if any. | |
static Stack * | cloneStack () |
Clone the diagnostic context for the current thread. | |
static void | inherit (Stack *stack) |
Inherit the diagnostic context of another thread. | |
static bool | get (LogString &dest) |
Get the current value of the NDC of the currrent thread. | |
static int | getDepth () |
Get the current nesting depth of this diagnostic context. | |
static bool | empty () |
Tests if the NDC is empty. | |
static LogString | pop () |
Pop top value off stack. | |
static bool | pop (std::string &buf) |
Pop top value off stack. | |
static LogString | peek () |
Looks at the last diagnostic context at the top of this NDC without removing it. | |
static bool | peek (std::string &buf) |
Get top value without removing value. | |
static void | push (const std::string &message) |
Push new diagnostic context information for the current thread. | |
static void | pushLS (const LogString &message) |
Push new diagnostic context information for the current thread. | |
static void | remove () |
Remove the diagnostic context for this thread. | |
static void | push (const std::wstring &message) |
Push new diagnostic context information for the current thread. | |
static bool | peek (std::wstring &dst) |
Appends the current NDC content to the provided string. | |
static bool | pop (std::wstring &dst) |
Appends the current NDC content to the provided string and removes the value from the NDC. | |
static void | push (const std::basic_string< UniChar > &message) |
Push new diagnostic context information for the current thread. | |
static bool | peek (std::basic_string< UniChar > &dst) |
Appends the current NDC content to the provided string. | |
static bool | pop (std::basic_string< UniChar > &dst) |
Appends the current NDC content to the provided string and removes the value from the NDC. | |
static void | push (const CFStringRef &message) |
Push new diagnostic context information for the current thread. | |
static bool | peek (CFStringRef &dst) |
Gets the current NDC value. | |
static bool | pop (CFStringRef &dst) |
Gets and removes the current NDC value. |
|
Pair of Message and FullMessage.
|
|
|
|
Creates a nested diagnostic context. Since java performs no automatic cleanup of objects when a scope is left, in log4j push() and pop() must be used to manage the NDC. For convenience, log4cxx provides an NDC constructor and destructor which simply call the push() and pop() methods, allowing for automatic cleanup when the current scope ends.
|
|
Removes the topmost element from the NDC stack.
|
|
Creates a nested diagnostic context. Since java performs no automatic cleanup of objects when a scope is left, in log4j push() and pop() must be used to manage the NDC. For convenience, log4cxx provides an NDC constructor and destructor which simply call the push() and pop() methods, allowing for automatic cleanup when the current scope ends.
|
|
Creates a nested diagnostic context. Since java performs no automatic cleanup of objects when a scope is left, in log4j push() and pop() must be used to manage the NDC. For convenience, log4cxx provides an NDC constructor and destructor which simply call the push() and pop() methods, allowing for automatic cleanup when the current scope ends.
|
|
Creates a nested diagnostic context. Since java performs no automatic cleanup of objects when a scope is left, in log4j push() and pop() must be used to manage the NDC. For convenience, log4cxx provides an NDC constructor and destructor which simply call the push() and pop() methods, allowing for automatic cleanup when the current scope ends.
|
|
Clear any nested diagnostic information if any. This method is useful in cases where the same thread can be potentially used over and over in different unrelated contexts. |
|
Clone the diagnostic context for the current thread. Internally a diagnostic context is represented as a stack. A given thread can supply the stack (i.e. diagnostic context) to a child thread so that the child can inherit the parent thread's diagnostic context. The child thread uses the inherit method to inherit the parent's diagnostic context. If not passed to inherit, returned stack should be deleted by caller.
|
|
Tests if the NDC is empty.
|
|
Get the current value of the NDC of the currrent thread.
|
|
Get the current nesting depth of this diagnostic context.
|
|
Inherit the diagnostic context of another thread. The parent thread can obtain a reference to its diagnostic context using the cloneStack method. It should communicate this information to its child so that it may inherit the parent's diagnostic context. The parent's diagnostic context is cloned before being inherited. In other words, once inherited, the two diagnostic contexts can be managed independently.
|
|
Gets the current NDC value.
|
|
Appends the current NDC content to the provided string.
|
|
Appends the current NDC content to the provided string.
|
|
Get top value without removing value.
|
|
Looks at the last diagnostic context at the top of this NDC without removing it. The returned value is the value that was pushed last. If no context is available, then the empty string "" is returned.
|
|
Gets and removes the current NDC value.
|
|
Appends the current NDC content to the provided string and removes the value from the NDC.
|
|
Appends the current NDC content to the provided string and removes the value from the NDC.
|
|
Pop top value off stack.
|
|
Pop top value off stack.
|
|
Push new diagnostic context information for the current thread.
The contents of the
|
|
Push new diagnostic context information for the current thread.
The contents of the
|
|
Push new diagnostic context information for the current thread.
The contents of the
|
|
Push new diagnostic context information for the current thread.
The contents of the
|
|
Push new diagnostic context information for the current thread.
The contents of the
|
|
Remove the diagnostic context for this thread. Each thread that created a diagnostic context by calling push should call this method before exiting. Otherwise, the memory used by the thread cannot be reclaimed by the VM.
As this is such an important problem in heavy duty systems and because it is difficult to always guarantee that the remove method is called before exiting a thread, this method has been augmented to lazily remove references to dead threads. In practice, this means that you can be a little sloppy and occasionally forget to call remove before exiting a thread. However, you must call |