eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/info/ServiceLogInfo.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 information about logging fields for application acting as service and handling requests from other
  24  * applications
  25  *
  26  * @author Rajiv Singla
  27  */
  28 public interface ServiceLogInfo extends LogInfo {
  29
  30     /**
  31      * Required field contains the developer given name of the ecomp component's exposed api (~='method', function')
  32      * invoked. For example if the application is exposing a REST interface and exposing runtime metrics then the
  33      * service name can be: appName-getMetrics
  34      *
  35      * @return name of the API invoked by the application
  36      */
  37     String getServiceName();
  38
  39
  40     /**
  41      * Optional field contains the name of the client or user invoking the service.
  42      * It may be an application, user name or mech id.
  43      *
  44      * @return name of the client or user invoking the API if known
  45      */
  46     String getPartnerName();
  47
  48
  49     /**
  50      * Optional field contains requesting remote client application’s IP address. Use UNKNOWN or an empty string if not
  51      * available.
  52      *
  53      * @return remote client application’s IP address
  54      */
  55     String getClientIPAddress();
  56
  57
  58 }
  59
  60
  61