Modified code in ECOMP-Logging to resolve critical/major sonar issues.
Not all issues were resolved as some guidance needs to be provided for
specific cases.
Restored config/policyLogger.properties file. It was modified by a junit
test.
Change-Id: I49fee98b2497d9d503d81bbbacbb1b416e1058a7
Signed-off-by: Magnusen, Drew (dm741q) <dm741q@att.com>
# Set level for error file. Set OFF to disable; set ON to enable
error.level=ON
# Set level for audit file. Set OFF to disable; set ON to enable
-audit.level=ON
+audit.level=ON
\ No newline at end of file
package org.onap.policy.common.logging;
-//import static org.onap.policy.common.logging.eelf.Configuration.TRANSACTION_BEGIN_TIME_STAMP;
-//import static org.onap.policy.common.logging.eelf.Configuration.TRANSACTION_ELAPSED_TIME;
-//import static org.onap.policy.common.logging.eelf.Configuration.TRANSACTION_END_TIME_STAMP;
import java.text.SimpleDateFormat;
import java.time.Duration;
private static LoggingContextFactory.Builder loggingContextBuilder = new LoggingContextFactory.Builder();
protected SharedLoggingContext context = null;
-// private long transactionStartTime = 0;
private Instant transactionStartTime;
private Instant metricStartTime;
* the duration of the transaction.
*/
public void transactionStarted() {
-// transactionStartTime = System.currentTimeMillis();
transactionStartTime = Instant.now();
setTransactionBeginTimestamp(transactionStartTime);
}
* the duration of the metric.
*/
public void metricStarted() {
-// transactionStartTime = System.currentTimeMillis();
metricStartTime = Instant.now();
setMetricBeginTimestamp(metricStartTime);
}
return context.get(CLASSNAME, "");
}
- /**
- * Set the value for the data item with key "timer".
- * An alternative to calling this method directly is to call
- * <code>transactionStarted()</code> at the start of transaction
- * processing and <code>transactionEnded()</code> at the end,
- * which will compute the time difference in milliseconds
- * and store the result as the "timer" value.
- *
- * @param id
- */
-// public void setTimer(Long timer) {
-// context.put(TIMER, timer);
-// }
-
-// public void setTimer(Long elapsedtime) {
-// String unit = " milliseconds";
-// context.put(TRANSACTION_ELAPSED_TIME, elapsedtime + unit);
-// }
-
- /**
- * Get the value for the data item with key "timer"
- * @return current value, or 0 if not set
- */
-// public long getTimer() {
-// return context.get(TRANSACTION_ELAPSED_TIME, 0);
-// }
/**
* Set the value for the data item with key "TransactionBeginTimestamp"
public void setTransactionElapsedTime(Instant transactionEndTime) {
long ns = Duration.between(transactionStartTime, transactionEndTime).toMillis();
- //String unit = " Seconds";
- //if(ns == 1){
- //unit = " Second";
- //}
-
- //if(ns < 1){
- //ns = Duration.between(transactionStartTime, transactionEndTime).toMillis();
- //unit = " milliseconds";
- //}
- context.put(TRANSACTION_ELAPSED_TIME, ns); // + unit);
+
+ context.put(TRANSACTION_ELAPSED_TIME, ns);
}
/**
public void setMetricElapsedTime(Instant metricEndTime) {
long ns = Duration.between(metricStartTime, metricEndTime).toMillis();
- //String unit = " Seconds";
- //if(ns == 1){
- //unit = " Second";
- //}
-
- //if(ns < 1){
- //ns = Duration.between(metricStartTime, metricEndTime).toMillis();
- //unit = " milliseconds";
- //}
- context.put(METRIC_ELAPSED_TIME, ns); // + unit);
+
+ context.put(METRIC_ELAPSED_TIME, ns);
}
/**
public class ONAPLoggingUtils {
+ private ONAPLoggingUtils() {};
+
public static ONAPLoggingContext getLoggingContextForRequest(HttpServletRequest request,
ONAPLoggingContext baseContext)
{
public class DroolsPDPMDCInfo implements MDCInfo{
- private static ConcurrentHashMap<String, String> mdcMap = new ConcurrentHashMap<String, String>();
+ private static ConcurrentHashMap<String, String> mdcMap = new ConcurrentHashMap<>();
static {
public class ErrorCodeMap {
- public static HashMap<MessageCodes, ErrorCodeInfo> hm = new HashMap<MessageCodes, ErrorCodeInfo>();
+ protected static final HashMap<MessageCodes, ErrorCodeInfo> hm = new HashMap<>();
private static String ERROR_PERMISSIONS = "POLICY-100E";
private static String ERROR_PERMISSIONS_DESCRIPTION = "This is a Permissions Error. Please check the error message for detail information";
hm.put(MessageCodes.ERROR_UNKNOWN, new ErrorCodeInfo(ERROR_UNKNOWN, ERROR_UNKNOWN_DESCRIPTION));
hm.put(MessageCodes.ERROR_AUDIT, new ErrorCodeInfo(ERROR_AUDIT, ERROR_AUDIT_DESCRIPTION));
}
-
+ private ErrorCodeMap() {};
static class ErrorCodeInfo {
private String errorCode;
private Instant startTime = null;
private Instant endTime = null;
+ //Default constructor takes no arguments.
+ //Is empty because instance variables are assigned
+ //their default values upon declaration.
public EventData() {
}
this.endTime = endTime;
}
+ @Override
public String toString(){
return requestID + " Starting Time : " + this.startTime + " Ending Time : " + this.endTime;
}
* Load factor of 0,9 ensures a dense packaging inside ConcurrentHashMap which will optimize memory use
* ConcurencyLevel set to 1 will ensure that only one shard is created and maintained
*/
- eventInfo = new ConcurrentHashMap<String, EventData>(16, 0.9f, 1);
+ eventInfo = new ConcurrentHashMap<>(16, 0.9f, 1);
}
/**
return;
}
- Instant startTime = null;
- long ns = 0;
+ Instant startTime;
+ long ns;
ArrayList<String> expiredEvents = null;
if (ns > PolicyLogger.EXPIRED_TIME){
if (expiredEvents == null) {
- expiredEvents = new ArrayList<String>();
+ expiredEvents = new ArrayList<>();
}
expiredEvents.add(key);
* Interface needs to be implemented by DroolsPDPMDCInfo
*
*/
-
+@FunctionalInterface
public interface MDCInfo {
public ConcurrentHashMap<String, String> getMDCInfo();
transId = UUID.randomUUID().toString();
}
- if(component != null && component.equalsIgnoreCase("DROOLS")){
+ if("DROOLS".equalsIgnoreCase(component)){
MDC.put(TARGET_ENTITY, "POLICY");
MDC.put(TARGET_SERVICE_NAME, "drools evaluate rule");
return postMDCInfoForEvent(transId, new DroolsPDPMDCInfo());
Instant startTime = Instant.now();
Instant endTime = Instant.now();
long ns = Duration.between(startTime, endTime).toMillis(); // use millisecond as default and remove unit from log
- //String unit = " Seconds";
- //if(ns == 1){
- //unit = " Second";
- //}
-
- //if(ns < 1){
- //ns = Duration.between(startTime, endTime).toMillis();
- //unit = " milliseconds";
- //}
+
MDC.put(MDC_INSTANCE_UUID, "");
MDC.put(MDC_ALERT_SEVERITY, "");
//set default values for these required fields below, they can be overridden
formatedTime = sdf.format(Date.from(endTime));
MDC.put(END_TIME_STAMP, formatedTime);
- MDC.put(ELAPSED_TIME, Long.toString(ns)); // + unit);
+ MDC.put(ELAPSED_TIME, Long.toString(ns));
MDC.put(PARTNER_NAME, "N/A");
ConcurrentHashMap<String, String> mdcMap = mdcInfo.getMDCInfo();
Iterator<String> keyIterator = mdcMap.keySet().iterator();
- String key = "";
+ String key;
while(keyIterator.hasNext()){
key = keyIterator.next();
Instant startTime = Instant.now();
Instant endTime = Instant.now();
long ns = Duration.between(startTime, endTime).toMillis(); // use millisecond as default and remove unit from log
- //String unit = " Seconds";
- //if(ns == 1){
- //unit = " Second";
- //}
-
- //if(ns < 1){
- //ns = Duration.between(startTime, endTime).toMillis();
- //unit = " milliseconds";
- //}
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd'T'HH:mm:ss.SSS+00:00");
//set default values for these required fields below, they can be overridden
formatedTime = sdf.format(Date.from(endTime));
MDC.put(END_TIME_STAMP, formatedTime);
- MDC.put(ELAPSED_TIME, Long.toString(ns)); // + unit);
+ MDC.put(ELAPSED_TIME, Long.toString(ns));
return transId;
}
Instant startTime = Instant.now();
Instant endTime = Instant.now();
long ns = Duration.between(startTime, endTime).toMillis();
- //String unit = " Seconds";
- //if(ns == 1){
- //unit = " Second";
- //}
-
- //if(ns < 1){
- //ns = Duration.between(startTime, endTime).toMillis();
- //unit = " milliseconds";
- //}
+
MDC.put(MDC_INSTANCE_UUID, "");
MDC.put(MDC_ALERT_SEVERITY, "");
//set default values for these required fields below, they can be overridden
formatedTime = sdf.format(Date.from(endTime));
MDC.put(END_TIME_STAMP, formatedTime);
- MDC.put(ELAPSED_TIME, Long.toString(ns)); // + unit);
+ MDC.put(ELAPSED_TIME, Long.toString(ns));
MDC.put(PARTNER_NAME, "N/A");
isEventTrackerRunning = true;
}
- }else if( size <= STOP_CHECK_POINT){
+ }else if( size <= STOP_CHECK_POINT && isEventTrackerRunning){
- if(isEventTrackerRunning){
- stopCleanUp();
- }
+ stopCleanUp();
}
}
MDC.put(RESPONSE_DESCRIPTION, "N/A");
long ns = Duration.between(startTime, endTime).toMillis();
- //String unit = " Seconds";
- //if(ns == 1){
- //unit = " Second";
- //}
- //if(ns < 1){
- //ns = Duration.between(startTime, endTime).toMillis();
- //unit = " milliseconds";
- //}
-
- MDC.put(ELAPSED_TIME, Long.toString(ns)); // + unit);
+ MDC.put(ELAPSED_TIME, Long.toString(ns));
auditLogger.info(MessageCodes.RULE_AUDIT_START_END_INFO,
serviceName, rule, startTime.toString(), endTime.toString(), Long.toString(ns), policyVersion);
//--- remove the record from the concurrentHashMap
- if(eventTracker != null){
- if(eventTracker.getEventDataByRequestID(eventId) != null){
- eventTracker.remove(eventId);
- debugLogger.info("eventTracker.remove(" + eventId + ")");
- }
+ if(eventTracker != null && eventTracker.getEventDataByRequestID(eventId) != null){
+
+ eventTracker.remove(eventId);
+ debugLogger.info("eventTracker.remove(" + eventId + ")");
+
}
}
PrintWriter pw = new PrintWriter(sw);
t.printStackTrace(pw);
String newStValue = sw.toString().replace ('|', '!').replace ("\n", " - ");
- int curSize = (arguments == null ? 0 : arguments.length);
+ int curSize = arguments == null ? 0 : arguments.length;
StringBuffer newArgument = new StringBuffer();
for(int i=0; i<curSize; i++) {
newArgument.append(arguments[i]);
// fetch and verify definitions of some properties
try{
- int timerDelayTime = Integer.parseInt(loggerProperties.getProperty("timer.delay.time", ""+1000));
- int checkInterval = Integer.parseInt(loggerProperties.getProperty("check.interval", ""+30000));
- int expiredDate = Integer.parseInt(loggerProperties.getProperty("event.expired.time",""+86400));
- int concurrentHashMapLimit = Integer.parseInt(loggerProperties.getProperty("concurrentHashMap.limit", ""+5000));
- int stopCheckPoint = Integer.parseInt(loggerProperties.getProperty("stop.check.point",""+2500));
+ int timerDelayTime = Integer.parseInt(loggerProperties.getProperty("timer.delay.time", Integer.toString(1000)));
+ int checkInterval = Integer.parseInt(loggerProperties.getProperty("check.interval", Integer.toString(30000)));
+ int expiredDate = Integer.parseInt(loggerProperties.getProperty("event.expired.time", Integer.toString(86400)));
+ int concurrentHashMapLimit = Integer.parseInt(loggerProperties.getProperty("concurrentHashMap.limit", Integer.toString(5000)));
+ int stopCheckPoint = Integer.parseInt(loggerProperties.getProperty("stop.check.point", Integer.toString(2500)));
String loggerType = loggerProperties.getProperty("logger.type",logger_type.toString());
String debugLevel = loggerProperties.getProperty("debugLogger.level","INFO");
String overrideLogbackLevel = loggerProperties.getProperty("override.logback.level.setup");
if(overrideLogbackLevel != null && !overrideLogbackLevel.isEmpty()) {
- if(overrideLogbackLevel.equalsIgnoreCase("TRUE")){
+ if("TRUE".equalsIgnoreCase(overrideLogbackLevel)){
isOverrideLogbackLevel = true;
}else{
isOverrideLogbackLevel = false;
if (loggerType != null){
- if (loggerType.equalsIgnoreCase("EELF")){
+ if ("EELF".equalsIgnoreCase(loggerType)){
logger_type = LoggerType.EELF;
- }else if (loggerType.equalsIgnoreCase("LOG4J")){
+ }else if ("LOG4J".equalsIgnoreCase(loggerType)){
logger_type = LoggerType.LOG4J;
- }else if (loggerType.equalsIgnoreCase("SYSTEMOUT")){
+ }else if ("SYSTEMOUT".equalsIgnoreCase(loggerType)){
logger_type = LoggerType.SYSTEMOUT;
public static void setErrorLevel(String errorLevel){
if(isOverrideLogbackLevel){
- if(errorLevel != null && errorLevel.equalsIgnoreCase("OFF")){
+ if("OFF".equalsIgnoreCase(errorLevel)){
PolicyLogger.ERROR_LEVEL = Level.OFF;
errorLogger.setLevel(ERROR_LEVEL);
}else{
public static void setMetricsLevel(String metricsLevel){
if(isOverrideLogbackLevel){
- if(metricsLevel != null && metricsLevel.equalsIgnoreCase("OFF")){
+ if("OFF".equalsIgnoreCase(metricsLevel)){
PolicyLogger.METRICS_LEVEL = Level.OFF;
metricsLogger.setLevel(METRICS_LEVEL);
}else {
public static void setAuditLevel(String auditLevel){
if(isOverrideLogbackLevel){
- if(auditLevel != null && auditLevel.equalsIgnoreCase("OFF")){
+ if("OFF".equalsIgnoreCase(auditLevel)){
PolicyLogger.AUDIT_LEVEL = Level.OFF;
auditLogger.setLevel(AUDIT_LEVEL);
}else {
public class FlexLogger extends SecurityManager{
private static LoggerType loggerType = LoggerType.EELF;
- private static ConcurrentHashMap<String, Logger4J> logger4JMap = new ConcurrentHashMap<String, Logger4J>();
- private static ConcurrentHashMap<String, EelfLogger> eelfLoggerMap = new ConcurrentHashMap<String, EelfLogger>();
- private static ConcurrentHashMap<String, SystemOutLogger> systemOutMap = new ConcurrentHashMap<String, SystemOutLogger>();
+ private static ConcurrentHashMap<String, Logger4J> logger4JMap = new ConcurrentHashMap<>();
+ private static ConcurrentHashMap<String, EelfLogger> eelfLoggerMap = new ConcurrentHashMap<>();
+ private static ConcurrentHashMap<String, SystemOutLogger> systemOutMap = new ConcurrentHashMap<>();
//--- init logger first
static {
loggerType = initlogger();
logger = getEelfLogger(clazz, false);
break;
case LOG4J:
- logger = getLog4JLogger(clazz);
+ logger = getLog4JLogger();
break;
case SYSTEMOUT:
- logger = getSystemOutLogger(null);
+ logger = getSystemOutLogger();
break;
}
logger = getLog4JLogger(s);
break;
case SYSTEMOUT:
- logger = getSystemOutLogger(null);
+ logger = getSystemOutLogger();
break;
}
logger = getEelfLogger(clazz, isNewTransaction);
break;
case LOG4J:
- logger = getLog4JLogger(clazz);
+ logger = getLog4JLogger();
break;
case SYSTEMOUT:
- logger = getSystemOutLogger(null);
+ logger = getSystemOutLogger();
break;
}
logger = getLog4JLogger(s);
break;
case SYSTEMOUT:
- logger = getSystemOutLogger(null);
+ logger = getSystemOutLogger();
break;
}
* Returns an instance of Logger4J
* @param clazz
*/
- private static Logger4J getLog4JLogger(Class<?> clazz){
+ private static Logger4J getLog4JLogger(){
String className = new FlexLogger().getClassName();
if(!logger4JMap.containsKey(className)){
*/
private static EelfLogger getEelfLogger(Class<?> clazz, boolean isNewTransaction){
- String className = "";
- EelfLogger logger = null;
+ String className;
+ EelfLogger logger;
if(clazz != null){
className = clazz.getName();
}else{
* Returns an instance of SystemOutLogger
* @param clazz
*/
- private static SystemOutLogger getSystemOutLogger(Class<?> clazz){
+ private static SystemOutLogger getSystemOutLogger(){
String className = new FlexLogger().getClassName();
if (loggerTypeString != null){
if (loggerTypeString.equalsIgnoreCase("EELF")){
loggerType = LoggerType.EELF;
- if (overrideLogbackLevel != null &&
- overrideLogbackLevel.equalsIgnoreCase("TRUE")) {
+ if ("TRUE".equalsIgnoreCase(overrideLogbackLevel)) {
System.out.println("FlexLogger: start listener.");
properties = PropertyUtil.getProperties
("config/policyLogger.properties",
/**
* This method will be called automatically if he policyLogger.properties got updated
*/
+ @Override
public void propertiesChanged(Properties properties,
Set<String> changedKeys) {
// get an instance of logger
Logger logger = FlexLogger.getLogger(FlexLoggerTester.class);
- //logger.info("this is a testing of FlexLogger with logger type:" + FlexLogger.loggerType);
-
logger.info("logger.isAuditEnabled():" + logger.isAuditEnabled());
logger.info("logger.isDebugEnabled():" + logger.isDebugEnabled());
logger.info("logger.isErrorEnabled():" + logger.isErrorEnabled());
// load properties (may throw an IOException)
rval.load(fis);
- return(rval);
+ return rval;
}
finally
{
*/
static public Properties getProperties(String fileName) throws IOException
{
- return(getProperties(new File(fileName)));
+ return getProperties(new File(fileName));
}
/* ============================================================ */
* This is the callback interface, used for sending notifications of
* changes in the properties file.
*/
+ @FunctionalInterface
public interface Listener
{
/**
// this table maps canonical file into a 'ListenerRegistration' instance
static private HashMap<File, ListenerRegistration> registrations =
- new HashMap<File, ListenerRegistration>();
+ new HashMap<>();
/**
* This is an internal class - one instance of this exists for each
properties = getProperties(file);
// no listeners yet
- listeners = new LinkedList<Listener>();
+ listeners = new LinkedList<>();
// add to static table, so this instance can be shared
registrations.put(file, this);
// create and schedule the timer task, so this is periodically polled
timerTask = new TimerTask()
{
+ @Override
public void run()
{
try
synchronized Properties addListener(Listener listener)
{
listeners.add(listener);
- return((Properties)properties.clone());
+ return (Properties)properties.clone();
}
/**
// one is being removed.
synchronized(registrations)
{
- if (listeners.size() == 0)
+ if (listeners.isEmpty())
{
timerTask.cancel();
registrations.remove(file);
// Save old set, and initial set of changed properties.
Properties oldProperties = properties;
HashSet<String> changedProperties =
- new HashSet<String>(oldProperties.stringPropertyNames());
+ new HashSet<>(oldProperties.stringPropertyNames());
// Fetch the list of listeners that we will potentially notify,
// and the new properties. Note that this is in a 'synchronized'
}
// 'changedProperties' should be correct at this point
- if (changedProperties.size() != 0)
+ if (!changedProperties.isEmpty())
{
// there were changes - notify everyone in 'listeners'
for (final Listener notify : listeners)
final Properties tmpProperties =
(Properties)(properties.clone());
final HashSet<String> tmpChangedProperties =
- new HashSet<String>(changedProperties);
+ new HashSet<>(changedProperties);
// Do the notification in a separate thread, so blocking
// won't cause any problems.
new Thread()
{
+ @Override
public void run()
{
notify.propertiesChanged
if (listener == null)
{
// no listener specified -- just fetch the properties
- return(getProperties(file));
+ return getProperties(file);
}
// Convert the file to a canonical form in order to avoid the situation
// where different names refer to the same file.
- file = file.getCanonicalFile();
+ File tempFile = file.getCanonicalFile();
// See if there is an existing registration. The 'synchronized' block
// is needed to handle the case where a new listener is added at about
// the same time that another one is being removed.
synchronized(registrations)
{
- ListenerRegistration reg = registrations.get(file);
+ ListenerRegistration reg = registrations.get(tempFile);
if (reg == null)
{
// a new registration is needed
- reg = new ListenerRegistration(file);
+ reg = new ListenerRegistration(tempFile);
}
- return(reg.addListener(listener));
+ return reg.addListener(listener);
}
}
static public Properties getProperties(String fileName, Listener listener)
throws IOException
{
- return(getProperties(new File(fileName), listener));
+ return getProperties(new File(fileName), listener);
}
/**
this.name = name;
}
+ @Override
public void propertiesChanged(Properties properties, Set<String> changedKeys)
{
System.out.println("Test(" + name + ")\nproperties = " + properties
public SharedContext ( LoggingContext base )
{
super ( base );
- fMap = new HashMap<String,String> ();
+ fMap = new HashMap<> ();
}
@Override
MDC.put ( key, value );
}
+ @Override
public void put ( String key, long value )
{
- put ( key, "" + value );
+ put ( key, Long.toString(value));
}
-
+ @Override
public String get ( String key, String defaultValue )
{
String result = MDC.get ( key );
return result;
}
+ @Override
public long get ( String key, long defaultValue )
{
- final String str = get ( key, "" + defaultValue );
+ final String str = get ( key, Long.toString(defaultValue));
try
{
return Long.parseLong ( str );
Code Review / policy / common.git / commitdiff