eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/RequestIdLogInfo.java

   1 /*
   2  * ================================================================================
   3  * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
   4  * ================================================================================
   5  * Licensed under the Apache License, Version 2.0 (the "License");
   6  * you may not use this file except in compliance with the License.
   7  * You may obtain a copy of the License at
   8  *
   9  *      http://www.apache.org/licenses/LICENSE-2.0
  10  *
  11  * Unless required by applicable law or agreed to in writing, software
  12  * distributed under the License is distributed on an "AS IS" BASIS,
  13  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14  * See the License for the specific language governing permissions and
  15  * limitations under the License.
  16  * ============LICENSE_END=========================================================
  17  *
  18  */
  19
  20 package org.onap.dcae.utils.eelf.logger.api.info;
  21
  22 /**
  23  * Captures fields required for logging request information
  24  *
  25  * @author Rajiv Singla
  26  */
  27 public interface RequestIdLogInfo extends LogInfo {
  28
  29     /**
  30      * Required field containing requestID which uniquely that identifies a single transaction request within the EELF
  31      * platform. Its value is conforms to RFC4122 UUID. The requestID value is passed using a REST API from one
  32      * EELF component to another via HTTP Headers named X-RequestID
  33      * <p>
  34      * <b>724229c0-9945-11e5-bcde-0002a5d5c51b:1234</b>
  35      * </p>
  36      * If receiving a composite requestID value, e.g. something of the form UUID-1:UUID-2, the receiving component
  37      * should only use the UUID-1 portion (i.e. remove the “:” and any trailing suffix, e.g. UUID-2) as the requestID
  38      * field value for its log files.
  39      *
  40      * @return requestID which uniquely that identifies a single transaction request within the EELF
  41      */
  42     String getRequestId();
  43
  44 }