You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@logging.apache.org by ma...@apache.org on 2018/07/03 17:07:43 UTC
[2/2] logging-log4j-audit git commit: Clarify annotations
Clarify annotations
Project: http://git-wip-us.apache.org/repos/asf/logging-log4j-audit/repo
Commit: http://git-wip-us.apache.org/repos/asf/logging-log4j-audit/commit/6ff3d707
Tree: http://git-wip-us.apache.org/repos/asf/logging-log4j-audit/tree/6ff3d707
Diff: http://git-wip-us.apache.org/repos/asf/logging-log4j-audit/diff/6ff3d707
Branch: refs/heads/master
Commit: 6ff3d707f112afac90a9c98e3a009dd8b124b8e8
Parents: 96e1779
Author: Matt Sicker <bo...@gmail.com>
Authored: Tue Jul 3 12:07:32 2018 -0500
Committer: Matt Sicker <bo...@gmail.com>
Committed: Tue Jul 3 12:07:32 2018 -0500
----------------------------------------------------------------------
src/site/markdown/requestContext.md.vm | 14 +++++---------
1 file changed, 5 insertions(+), 9 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/logging-log4j-audit/blob/6ff3d707/src/site/markdown/requestContext.md.vm
----------------------------------------------------------------------
diff --git a/src/site/markdown/requestContext.md.vm b/src/site/markdown/requestContext.md.vm
index b6a9e9d..0083f42 100644
--- a/src/site/markdown/requestContext.md.vm
+++ b/src/site/markdown/requestContext.md.vm
@@ -89,16 +89,16 @@ public final class RequestContext {
```
$h2 RequestContext Annotations
$h3 HeaderPrefix
-The HeaderPrefix annotation is used to define the string to be prepended to the names of the ThreadContext variables
+The `@HeaderPrefix` annotation is used to define the string to be prepended to the names of the ThreadContext variables
when they are passed to a REST service. The default value is "request-context-".
$h3 Mapping Annotations
-The ClientServer, Local, and Chained annotations represent the 3 types of RequestContext variables.
+The `@ClientServer`, `@Local`, and `@Chained` annotations represent the 3 types of RequestContext variables.
<ul>
-<li>ClientServer represents a variable whose value should be passed to the target service using the same name.</li>
-<li>Local represents a variable that is used in the local application and should not be passed to a client service.</li>
-<li>Chained represents a variable that should be passed to the target service using a new name. A variable with the
+<li>`@ClientServer` represents a variable whose value should be passed to the target service using the same name.</li>
+<li>`@Local` represents a variable that is used in the local application and should not be passed to a client service.</li>
+<li>`@Chained` represents a variable that should be passed to the target service using a new name. A variable with the
same named may be created in the target service using a different value. This is primarily used to pass the name
of the current server to the target service.</li>
</ul>
@@ -253,7 +253,3 @@ $h2 Configuring Logging to Include RequestContext Variables
When logging RequestContext variables simply configure log4j2.xml to include specific ThreadContext variables or
all of them using the %X pattern converter or by setting the includeMdc, includeThreadContext, or properties attribute
to true on the desired Layout.
-```
-```
-
-