2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright © 2018 Amdocs
7 * ================================================================================
8 * Licensed under the Apache License, Version 2.0 (the "License");
9 * you may not use this file except in compliance with the License.
10 * You may obtain a copy of the License at
12 * http://www.apache.org/licenses/LICENSE-2.0
14 * Unless required by applicable law or agreed to in writing, software
15 * distributed under the License is distributed on an "AS IS" BASIS,
16 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17 * See the License for the specific language governing permissions and
18 * limitations under the License.
19 * ============LICENSE_END=========================================================
22 package org.onap.logging.ref.slf4j;
24 import org.slf4j.Marker;
25 import org.slf4j.MarkerFactory;
28 * Constants for standard ONAP headers, MDCs, etc.
30 * <p>See <tt>package-info.java</tt>.</p>
32 public final class ONAPLogConstants {
34 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
38 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
41 * Hide and forbid construction.
43 private ONAPLogConstants() {
44 throw new UnsupportedOperationException();
47 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
51 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
56 public static final class Markers {
58 /** Marker reporting invocation. */
59 public static final Marker INVOKE = MarkerFactory.getMarker("INVOKE");
61 /** Marker reporting synchronous invocation. */
62 public static final Marker INVOKE_SYNCHRONOUS = build("INVOKE", "SYNCHRONOUS");
64 /** Marker reporting asynchronous invocation. */
65 public static final Marker INVOKE_ASYNCHRONOUS = build("INVOKE", "ASYNCHRONOUS");
67 /** Marker reporting entry into a component. */
68 public static final Marker ENTRY = MarkerFactory.getMarker("ENTRY");
70 /** Marker reporting exit from a component. */
71 public static final Marker EXIT = MarkerFactory.getMarker("EXIT");
74 * Build nested, detached marker.
75 * @param m1 top token.
76 * @param m2 sub-token.
77 * @return detached Marker.
79 private static Marker build(final String m1, final String m2) {
80 final Marker marker = MarkerFactory.getDetachedMarker(m1);
81 marker.add(MarkerFactory.getDetachedMarker(m2));
86 * Hide and forbid construction.
89 throw new UnsupportedOperationException();
96 public static final class MDCs {
98 // Tracing. ////////////////////////////////////////////////////////////
100 /** MDC correlating messages for an invocation. */
101 public static final String INVOCATION_ID = "InvocationID";
103 /** MDC correlating messages for a logical transaction. */
104 public static final String REQUEST_ID = "RequestID";
106 /** MDC recording calling service. */
107 public static final String PARTNER_NAME = "PartnerName";
109 /** MDC recording current service. */
110 public static final String SERVICE_NAME = "ServiceName";
112 /** MDC recording target service. */
113 public static final String TARGET_SERVICE_NAME = "TargetServiceName";
115 /** MDC recording current service instance. */
116 public static final String INSTANCE_UUID = "InstanceUUID";
118 // Network. ////////////////////////////////////////////////////////////
120 /** MDC recording caller address. */
121 public static final String CLIENT_IP_ADDRESS = "ClientIPAddress";
123 /** MDC recording server address. */
124 public static final String SERVER_FQDN = "ServerFQDN";
127 * MDC recording timestamp at the start of the current request,
128 * with the same scope as {@link #REQUEST_ID}.
132 * <ul>Easily confused with {@link #INVOKE_TIMESTAMP}.</ul>
133 * <ul>No mechanism for propagation between components, e.g. via HTTP headers.</ul>
134 * <ul>Whatever mechanism we define, it's going to be costly.</ul>
138 public static final String ENTRY_TIMESTAMP = "EntryTimestamp";
140 /** MDC recording timestamp at the start of the current invocation. */
141 public static final String INVOKE_TIMESTAMP = "InvokeTimestamp";
143 // Outcomes. ///////////////////////////////////////////////////////////
145 /** MDC reporting outcome code. */
146 public static final String RESPONSE_CODE = "ResponseCode";
148 /** MDC reporting outcome description. */
149 public static final String RESPONSE_DESCRIPTION = "ResponseDescription";
151 /** MDC reporting outcome error level. */
152 public static final String RESPONSE_SEVERITY = "Severity";
154 /** MDC reporting outcome error level. */
155 public static final String RESPONSE_STATUS_CODE = "StatusCode";
157 // Unsorted. ///////////////////////////////////////////////////////////
160 * Hide and forbid construction.
163 throw new UnsupportedOperationException();
168 * Header name constants.
170 public static final class Headers {
172 /** HTTP <tt>X-ONAP-RequestID</tt> header. */
173 public static final String REQUEST_ID = "X-ONAP-RequestID";
175 /** HTTP <tt>X-ONAP-InvocationID</tt> header. */
176 public static final String INVOCATION_ID = "X-ONAP-InvocationID";
178 /** HTTP <tt>X-ONAP-PartnerName</tt> header. */
179 public static final String PARTNER_NAME = "X-ONAP-PartnerName";
182 * Hide and forbid construction.
185 throw new UnsupportedOperationException();
189 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
193 ////////////////////////////////////////////////////////////////////////////////////////////////////////////////////
196 * Response success or not, for setting <tt>StatusCode</tt>.
198 public enum ResponseStatus {
208 * Synchronous or asynchronous execution, for setting invocation marker.
210 public enum InvocationMode {
212 /** Synchronous, blocking. */
213 SYNCHRONOUS("SYNCHRONOUS", Markers.INVOKE_SYNCHRONOUS),
215 /** Asynchronous, non-blocking. */
216 ASYNCHRONOUS("ASYNCHRONOUS", Markers.INVOKE_ASYNCHRONOUS);
219 private String mString;
221 /** Corresponding marker. */
222 private Marker mMarker;
227 * @param s enum value.
228 * @param m corresponding Marker.
230 InvocationMode(final String s, final Marker m) {
236 * Get Marker for enum.
240 public Marker getMarker() {
248 public String toString() {