ECOMPLoggingContext (Policy Engine - Common Modules 1.1.0 API)

java.lang.Object
- org.openecomp.policy.common.logging.ECOMPLoggingContext

```
public class ECOMPLoggingContext
extends Object
```
A facade over the org.openecomp.policy.common.logging.nsa.SharedLoggingContext interface/implementation that makes it more convenient to use. SharedLoggingContext builds on the SLF4J/log4j Mapped Diagnostic Context (MDC) feature, which provides a hashmap-based context for data items that need to be logged, where the hashmap is kept in ThreadLocal storage. The data items can be referenced in the log4j configuration using the EnhancedPatternLayout appender layout class, and the notation "%X{key}" in the ConversionPattern string, where "key" is one of the keys in the MDC hashmap (which is determined by what hashmap entries the application code creates). Example: log4j.appender.auditAppender.layout=org.apache.log4j.EnhancedPatternLayout log4j.appender.auditAppender.layout.ConversionPattern=%d|%X{requestId}|%X{serviceInstanceId}|...|%m%n where "requestId" and "serviceInstanceId" are entries in the MDC hashmap. The notable functionality the SharedLoggingContext adds over MDC is that it maintains its own copy of the MDC data items in a hashmap (not in ThreadLocal storage), which allows more control of the data. The ECOMPLoggingContext constructor that takes another ECOMPLoggingContext object as a parameter makes use of this feature. For example if there is a thread pulling requests from a queue for processing, it can keep a base logging context with data that is common to all requests, and for each request, create a new logging context with that base context as a parameter; this will create a new logging context with those initial values and none of the request-specific values from the previous request such as a request ID. The setter methods in this class set corresponding items in the SharedLoggingContext/MDC hashmaps. These items correspond to the fields defined in the "ECOMP platform application logging guidelines" document. In addition, there is a pair of convenience functions, transactionStarted() and transactionEnded(), that can be called at the beginning and end of transaction processing to calculate the duration of the transaction and record that value in the "timer" item.

Field Summary

Fields
Modifier and Type Field and Description

protected SharedLoggingContext context

Fields
Modifier and Type	Field and Description
`protected SharedLoggingContext`	`context`

Constructor Summary

Constructors
Constructor and Description
`ECOMPLoggingContext()` Create a new ECOMPLoggingContext with no base context.
`ECOMPLoggingContext(ECOMPLoggingContext baseContext)` Create a new ECOMPLoggingContext initially populated with the values in the given base context.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getClassname()` Get the value for the data item with key "classname"
`String`	`getClientIPAddress()` Get the value for the data item with key "clientIp"
`String`	`getInstanceUUID()` Get the value for the data item with key "instanceUuid"
`long`	`getMetricBeginTimestamp()` Get the value for the data item with key "MetricBeginTimestamp"
`long`	`getMetricElapsedTime()` Get the value for the data item with key "MetricElapsedTime"
`long`	`getMetricEndTimestamp()` Get the value for the data item with key "MetricEndTimestamp"
`String`	`getPartnerName()` Get the value for the data item with key "partnerName"
`String`	`getRequestID()` Get the value for the data item with key "requestId"
`String`	`getServer()` Get the value for the data item with key "server"
`String`	`getServerIPAddress()` Get the value for the data item with key "serverIp"
`String`	`getServerName()` Get the value for the data item with key "serverName"
`String`	`getServiceInstanceID()` Get the value for the data item with key "serviceInstanceId"
`String`	`getServiceName()` Get the value for the data item with key "serviceName"
`String`	`getSeverity()` Get the value for the data item with key "severity"
`String`	`getStatusCode()` Get the value for the data item with key "statusCode"
`String`	`getTargetEntity()` Get the value for the data item with key "targetEntity"
`String`	`getTargetServiceName()` Get the value for the data item with key "targetServiceName"
`String`	`getThreadID()` Get the value for the data item with key "threadId"
`long`	`getTransactionBeginTimestamp()` Get the value for the data item with key "TransactionBeginTimestamp"
`long`	`getTransactionElapsedTime()` Get the value for the data item with key "TransactionElapsedTime"
`long`	`getTransactionEndTimestamp()` Get the value for the data item with key "TransactionEndTimestamp"
`void`	`metricEnded()` Indicate the end of metric processing.
`void`	`metricStarted()` Indicate the start of metric processing.
`void`	`setClassname(String classname)` Set the value for the data item with key "classname".
`void`	`setClientIPAddress(String clientIP)` Set the value for the data item with key "clientIp"
`void`	`setInstanceUUID(String uuid)` Set the value for the data item with key "instanceUuid"
`void`	`setMetricBeginTimestamp(Instant metricStartTime)` Set the value for the data item with key "MetricBeginTimestamp"
`void`	`setMetricElapsedTime(Instant metricEndTime)` Set the value for the data item with key "MetricElapsedTime".
`void`	`setMetricEndTimestamp(Instant metricEndTime)` Set the value for the data item with key "MetricEndTimestamp"
`void`	`setPartnerName(String name)` Set the value for the data item with key "partnerName"
`void`	`setRequestID(String id)` Set the value for the data item with key "requestId"
`void`	`setServer(String server)` Set the value for the data item with key "server"
`void`	`setServerIPAddress(String serverIP)` Set the value for the data item with key "serverIp"
`void`	`setServerName(String name)` Set the value for the data item with key "serverName"
`void`	`setServiceInstanceID(String id)` Set the value for the data item with key "serviceInstanceId"
`void`	`setServiceName(String name)` Set the value for the data item with key "serviceName"
`void`	`setSeverity(Long severity)` Set the value for the data item with key "severity"
`void`	`setStatusCode(String name)` Set the value for the data item with key "statusCode"
`void`	`setTargetEntity(String name)` Set the value for the data item with key "targetEntity"
`void`	`setTargetServiceName(String name)` Set the value for the data item with key "targetServiceName"
`void`	`setThreadID(String id)` Set the value for the data item with key "threadId".
`void`	`setTransactionBeginTimestamp(Instant transactionStartTime)` Set the value for the data item with key "TransactionBeginTimestamp"
`void`	`setTransactionElapsedTime(Instant transactionEndTime)` Set the value for the data item with key "TransactionElapsedTime".
`void`	`setTransactionEndTimestamp(Instant transactionEndTime)` Set the value for the data item with key "TransactionEndTimestamp"
`void`	`transactionEnded()` Indicate the end of transaction processing.
`void`	`transactionStarted()` Indicate the start of transaction processing.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - context
```
protected SharedLoggingContext context
```
- Constructor Detail
  - ECOMPLoggingContext
```
public ECOMPLoggingContext()
```
    Create a new ECOMPLoggingContext with no base context.
  - ECOMPLoggingContext
```
public ECOMPLoggingContext(ECOMPLoggingContext baseContext)
```
    Create a new ECOMPLoggingContext initially populated with the values in the given base context. This can be used for example in a servlet where each incoming request may be processed by a separate thread, but there may be some logging data items that will be unchanging and common to all the threads. That constant data can be populated in a base context, and then each request handler creates new context passing that base context to populate the common data in the new one.
    
    Parameters:
    
    baseContext -
- Method Detail
  - transactionStarted
```
public void transactionStarted()
```
    Indicate the start of transaction processing. The current system time will be recorded for use by transactionEnded() to calculate the duration of the transaction.
  - transactionEnded
```
public void transactionEnded()
```
    Indicate the end of transaction processing. The difference between the current system time and the time recorded by transactionStarted() will be recorded in the data item with key "TransactionElapsedTime".
  - metricStarted
```
public void metricStarted()
```
    Indicate the start of metric processing. The current system time will be recorded for use by metricEnded() to calculate the duration of the metric.
  - metricEnded
```
public void metricEnded()
```
    Indicate the end of metric processing. The difference between the current system time and the time recorded by metricStarted() will be recorded in the data item with key "MetricElapsedTime".
  - setRequestID
```
public void setRequestID(String id)
```
    Set the value for the data item with key "requestId"
    
    Parameters:
    
    id -
  - getRequestID
```
public String getRequestID()
```
    Get the value for the data item with key "requestId"
    
    Returns:
    
    current value, or empty string if not set
  - setServiceInstanceID
```
public void setServiceInstanceID(String id)
```
    Set the value for the data item with key "serviceInstanceId"
    
    Parameters:
    
    id -
  - getServiceInstanceID
```
public String getServiceInstanceID()
```
    Get the value for the data item with key "serviceInstanceId"
    
    Returns:
    
    current value, or empty string if not set
  - setThreadID
```
public void setThreadID(String id)
```
    Set the value for the data item with key "threadId". An alternative to using this item is to use the %t conversion character in the appender's conversion string.
    
    Parameters:
    
    id -
  - getThreadID
```
public String getThreadID()
```
    Get the value for the data item with key "threadId"
    
    Returns:
    
    current value, or empty string if not set
  - setServerName
```
public void setServerName(String name)
```
    Set the value for the data item with key "serverName"
    
    Parameters:
    
    id -
  - getServerName
```
public String getServerName()
```
    Get the value for the data item with key "serverName"
    
    Returns:
    
    current value, or empty string if not set
  - setServiceName
```
public void setServiceName(String name)
```
    Set the value for the data item with key "serviceName"
    
    Parameters:
    
    id -
  - getServiceName
```
public String getServiceName()
```
    Get the value for the data item with key "serviceName"
    
    Returns:
    
    current value, or empty string if not set
  - setPartnerName
```
public void setPartnerName(String name)
```
    Set the value for the data item with key "partnerName"
    
    Parameters:
    
    id -
  - getPartnerName
```
public String getPartnerName()
```
    Get the value for the data item with key "partnerName"
    
    Returns:
    
    current value, or empty string if not set
  - setStatusCode
```
public void setStatusCode(String name)
```
    Set the value for the data item with key "statusCode"
    
    Parameters:
    
    id -
  - getStatusCode
```
public String getStatusCode()
```
    Get the value for the data item with key "statusCode"
    
    Returns:
    
    current value, or empty string if not set
  - setTargetEntity
```
public void setTargetEntity(String name)
```
    Set the value for the data item with key "targetEntity"
    
    Parameters:
    
    id -
  - getTargetEntity
```
public String getTargetEntity()
```
    Get the value for the data item with key "targetEntity"
    
    Returns:
    
    current value, or empty string if not set
  - setTargetServiceName
```
public void setTargetServiceName(String name)
```
    Set the value for the data item with key "targetServiceName"
    
    Parameters:
    
    id -
  - getTargetServiceName
```
public String getTargetServiceName()
```
    Get the value for the data item with key "targetServiceName"
    
    Returns:
    
    current value, or empty string if not set
  - setInstanceUUID
```
public void setInstanceUUID(String uuid)
```
    Set the value for the data item with key "instanceUuid"
    
    Parameters:
    
    id -
  - getInstanceUUID
```
public String getInstanceUUID()
```
    Get the value for the data item with key "instanceUuid"
    
    Returns:
    
    current value, or empty string if not set
  - setSeverity
```
public void setSeverity(Long severity)
```
    Set the value for the data item with key "severity"
    
    Parameters:
    
    id -
  - getSeverity
```
public String getSeverity()
```
    Get the value for the data item with key "severity"
    
    Returns:
    
    current value, or empty string if not set
  - setServerIPAddress
```
public void setServerIPAddress(String serverIP)
```
    Set the value for the data item with key "serverIp"
    
    Parameters:
    
    id -
  - getServerIPAddress
```
public String getServerIPAddress()
```
    Get the value for the data item with key "serverIp"
    
    Returns:
    
    current value, or empty string if not set
  - setServer
```
public void setServer(String server)
```
    Set the value for the data item with key "server"
    
    Parameters:
    
    id -
  - getServer
```
public String getServer()
```
    Get the value for the data item with key "server"
    
    Returns:
    
    current value, or empty string if not set
  - setClientIPAddress
```
public void setClientIPAddress(String clientIP)
```
    Set the value for the data item with key "clientIp"
    
    Parameters:
    
    id -
  - getClientIPAddress
```
public String getClientIPAddress()
```
    Get the value for the data item with key "clientIp"
    
    Returns:
    
    current value, or empty string if not set
  - setClassname
```
public void setClassname(String classname)
```
    Set the value for the data item with key "classname". Use of this item is not recommended (unless it is used to indicate something other than the Java classname) since it would be unwieldy to maintain a correct value across calls to/returns from methods in other classes. Use of the PatternLayout %c conversion character in the conversion string will give a more reliable value.
    
    Parameters:
    
    id -
  - getClassname
```
public String getClassname()
```
    Get the value for the data item with key "classname"
    
    Returns:
    
    current value, or empty string if not set
  - setTransactionBeginTimestamp
```
public void setTransactionBeginTimestamp(Instant transactionStartTime)
```
    Set the value for the data item with key "TransactionBeginTimestamp"
    
    Parameters:
    
    id -
  - getTransactionBeginTimestamp
```
public long getTransactionBeginTimestamp()
```
    Get the value for the data item with key "TransactionBeginTimestamp"
    
    Returns:
    
    current value, or 0 if not set
  - setTransactionEndTimestamp
```
public void setTransactionEndTimestamp(Instant transactionEndTime)
```
    Set the value for the data item with key "TransactionEndTimestamp"
    
    Parameters:
    
    id -
  - getTransactionEndTimestamp
```
public long getTransactionEndTimestamp()
```
    Get the value for the data item with key "TransactionEndTimestamp"
    
    Returns:
    
    current value, or 0 if not set
  - setTransactionElapsedTime
```
public void setTransactionElapsedTime(Instant transactionEndTime)
```
    Set the value for the data item with key "TransactionElapsedTime". An alternative to calling this method directly is to call transactionStarted() at the start of transaction processing and transactionEnded() at the end, which will compute the time difference in milliseconds and store the result as the "ns" value.
    
    Parameters:
    
    id -
  - getTransactionElapsedTime
```
public long getTransactionElapsedTime()
```
    Get the value for the data item with key "TransactionElapsedTime"
    
    Returns:
    
    current value, or 0 if not set
  - setMetricBeginTimestamp
```
public void setMetricBeginTimestamp(Instant metricStartTime)
```
    Set the value for the data item with key "MetricBeginTimestamp"
    
    Parameters:
    
    id -
  - getMetricBeginTimestamp
```
public long getMetricBeginTimestamp()
```
    Get the value for the data item with key "MetricBeginTimestamp"
    
    Returns:
    
    current value, or 0 if not set
  - setMetricEndTimestamp
```
public void setMetricEndTimestamp(Instant metricEndTime)
```
    Set the value for the data item with key "MetricEndTimestamp"
    
    Parameters:
    
    id -
  - getMetricEndTimestamp
```
public long getMetricEndTimestamp()
```
    Get the value for the data item with key "MetricEndTimestamp"
    
    Returns:
    
    current value, or 0 if not set
  - setMetricElapsedTime
```
public void setMetricElapsedTime(Instant metricEndTime)
```
    Set the value for the data item with key "MetricElapsedTime". An alternative to calling this method directly is to call metricStarted() at the start of metric processing and metricEnded() at the end, which will compute the time difference in milliseconds and store the result as the "ns" value.
    
    Parameters:
    
    id -
  - getMetricElapsedTime
```
public long getMetricElapsedTime()
```
    Get the value for the data item with key "MetricElapsedTime"
    
    Returns:
    
    current value, or 0 if not set

Class ECOMPLoggingContext

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

context

Constructor Detail

ECOMPLoggingContext

ECOMPLoggingContext

Method Detail

transactionStarted

transactionEnded

metricStarted

metricEnded

setRequestID

getRequestID

setServiceInstanceID

getServiceInstanceID

setThreadID

getThreadID

setServerName

getServerName

setServiceName

getServiceName

setPartnerName

getPartnerName

setStatusCode

getStatusCode

setTargetEntity

getTargetEntity

setTargetServiceName

getTargetServiceName

setInstanceUUID

getInstanceUUID

setSeverity

getSeverity

setServerIPAddress

getServerIPAddress

setServer

getServer

setClientIPAddress

getClientIPAddress

setClassname

getClassname

setTransactionBeginTimestamp

getTransactionBeginTimestamp

setTransactionEndTimestamp

getTransactionEndTimestamp

setTransactionElapsedTime

getTransactionElapsedTime

setMetricBeginTimestamp

getMetricBeginTimestamp

setMetricEndTimestamp

getMetricEndTimestamp

setMetricElapsedTime

getMetricElapsedTime