ms/blueprintsprocessor/modules/commons/grpc-lib/src/main/kotlin/org/onap/ccsdk/cds/blueprintsprocessor/grpc/service/GrpcLoggerService.kt

   1 /*
   2  * Copyright © 2018-2019 AT&T Intellectual Property.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 package org.onap.ccsdk.cds.blueprintsprocessor.grpc.service
  18
  19 import io.grpc.Grpc
  20 import io.grpc.Metadata
  21 import io.grpc.ServerCall
  22 import io.grpc.ServerCallHandler
  23 import org.onap.ccsdk.cds.blueprintsprocessor.grpc.getStringKey
  24 import org.onap.ccsdk.cds.blueprintsprocessor.grpc.putStringKeyValue
  25 import org.onap.ccsdk.cds.controllerblueprints.common.api.CommonHeader
  26 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants.ONAP_INVOCATION_ID
  27 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants.ONAP_PARTNER_NAME
  28 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintConstants.ONAP_REQUEST_ID
  29 import org.onap.ccsdk.cds.controllerblueprints.core.BluePrintProcessorException
  30 import org.onap.ccsdk.cds.controllerblueprints.core.defaultToEmpty
  31 import org.onap.ccsdk.cds.controllerblueprints.core.defaultToUUID
  32 import org.onap.ccsdk.cds.controllerblueprints.core.logger
  33 import org.slf4j.MDC
  34 import java.net.InetAddress
  35 import java.net.InetSocketAddress
  36 import java.time.ZoneOffset
  37 import java.time.ZonedDateTime
  38 import java.time.format.DateTimeFormatter
  39 import java.util.*
  40
  41 class GrpcLoggerService {
  42
  43     private val log = logger(GrpcLoggerService::class)
  44
  45     /** Used when server receives request */
  46     fun <ReqT : Any, RespT : Any> grpcRequesting(call: ServerCall<ReqT, RespT>,
  47                                                  headers: Metadata, next: ServerCallHandler<ReqT, RespT>) {
  48         val requestID = headers.getStringKey(ONAP_REQUEST_ID).defaultToUUID()
  49         val invocationID = headers.getStringKey(ONAP_INVOCATION_ID).defaultToUUID()
  50         val partnerName = headers.getStringKey(ONAP_PARTNER_NAME) ?: "UNKNOWN"
  51         grpcRequesting(requestID, invocationID, partnerName, call)
  52     }
  53
  54     fun <ReqT : Any, RespT : Any> grpcRequesting(call: ServerCall<ReqT, RespT>,
  55                                                  headers: CommonHeader, next: ServerCallHandler<ReqT, RespT>) {
  56         val requestID = headers.requestId.defaultToUUID()
  57         val invocationID = headers.subRequestId.defaultToUUID()
  58         val partnerName = headers.originatorId ?: "UNKNOWN"
  59         grpcRequesting(requestID, invocationID, partnerName, call)
  60     }
  61
  62     fun <ReqT : Any, RespT : Any> grpcRequesting(requestID: String, invocationID: String, partnerName: String,
  63                                                  call: ServerCall<ReqT, RespT>) {
  64         val localhost = InetAddress.getLocalHost()
  65
  66         val clientSocketAddress = call.attributes.get(Grpc.TRANSPORT_ATTR_REMOTE_ADDR) as? InetSocketAddress
  67                 ?: throw BluePrintProcessorException("failed to get client address")
  68         val serviceName = call.methodDescriptor.fullMethodName
  69
  70         MDC.put("InvokeTimestamp", ZonedDateTime.now(ZoneOffset.UTC).format(DateTimeFormatter.ISO_INSTANT))
  71         MDC.put("RequestID", requestID)
  72         MDC.put("InvocationID", invocationID)
  73         MDC.put("PartnerName", partnerName)
  74         MDC.put("ClientIPAddress", clientSocketAddress.address.defaultToEmpty())
  75         MDC.put("ServerFQDN", localhost.hostName.defaultToEmpty())
  76         MDC.put("ServiceName", serviceName)
  77         log.trace("MDC Properties : ${MDC.getCopyOfContextMap()}")
  78     }
  79
  80
  81     /** Used before invoking any GRPC outbound request, Inbound Invocation ID is used as request Id
  82      * for outbound Request, If invocation Id is missing then default Request Id will be generated.
  83      */
  84     fun grpcInvoking(requestHeader: Metadata) {
  85         requestHeader.putStringKeyValue(ONAP_REQUEST_ID, MDC.get("InvocationID").defaultToUUID())
  86         requestHeader.putStringKeyValue(ONAP_INVOCATION_ID, UUID.randomUUID().toString())
  87         val partnerName = System.getProperty("APPNAME") ?: "BlueprintsProcessor"
  88         requestHeader.putStringKeyValue(ONAP_PARTNER_NAME, partnerName)
  89     }
  90
  91     /** Used when server returns response */
  92     fun grpResponding(requestHeaders: Metadata, responseHeaders: Metadata) {
  93         try {
  94             responseHeaders.putStringKeyValue(ONAP_REQUEST_ID, MDC.get("RequestID").defaultToEmpty())
  95             responseHeaders.putStringKeyValue(ONAP_INVOCATION_ID, MDC.get("InvocationID").defaultToEmpty())
  96             responseHeaders.putStringKeyValue(ONAP_PARTNER_NAME, MDC.get("PartnerName").defaultToEmpty())
  97         } catch (e: Exception) {
  98             log.warn("couldn't set grpc response headers", e)
  99         }
 100     }
 101 }