eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/MiscLogInfo.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 optional / deprecated fields that can be populated as per EELF Logging Requirements
  24  *
  25  * @author Rajiv Singla
  26  */
  27 public interface MiscLogInfo extends LogInfo {
  28
  29     /**
  30      * Optional field that can can be used to capture the flow of a transaction through the system by
  31      * indicating the components and operations involved in processed. If present, it can be denoted by a comma
  32      * separated list of components and applications.
  33      *
  34      * @return list of comma separated components and operations involved in processing
  35      */
  36     String getProcessId();
  37
  38     /**
  39      * This field is deprecated and should be left empty.
  40      *
  41      * @return deprecated field value - should be empty
  42      */
  43     String getUnused();
  44
  45 }