eelf-logger/eelf-logger-logback-impl/src/main/java/org/onap/dcae/utils/eelf/logger/logback/log/MetricLogImpl.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.logback.log;
  21
  22 import org.onap.dcae.utils.eelf.logger.api.info.LogLevelCategory;
  23 import org.onap.dcae.utils.eelf.logger.api.log.MetricLog;
  24 import org.onap.dcae.utils.eelf.logger.api.spec.MetricLogSpec;
  25 import org.onap.dcae.utils.eelf.logger.api.spec.OptionalLogSpec;
  26 import org.onap.dcae.utils.eelf.logger.logback.utils.LogUtils;
  27 import org.slf4j.Logger;
  28
  29 /**
  30  * Metric Log Logback Implementation
  31  *
  32  * @author Rajiv Singla
  33  */
  34 public class MetricLogImpl implements MetricLog {
  35
  36     private final Logger logger;
  37     private final Class<?> clazz;
  38
  39     public MetricLogImpl(final Logger logger, final Class<?> clazz) {
  40         this.logger = logger;
  41         this.clazz = clazz;
  42     }
  43
  44
  45     @Override
  46     public void log(final LogLevelCategory logLevelCategory, final String message, final MetricLogSpec metricLogSpec,
  47                     final OptionalLogSpec optionalLogSpec, final String... args) {
  48
  49         // if metric log spec or log level category is null throw an exception
  50         if (metricLogSpec == null || logLevelCategory == null) {
  51             throw new IllegalArgumentException("Metric Log Spec and Log level category must not be null");
  52         }
  53
  54         // required fields
  55         LogUtils.CUSTOM_MDC_MAP.put(LogUtils.LOG_LEVEL_CATEGORY_KEY, logLevelCategory);
  56         LogUtils.CUSTOM_MDC_MAP.put(LogUtils.METRIC_LOG_SPEC_KEY, metricLogSpec);
  57         LogUtils.CUSTOM_MDC_MAP.put(LogUtils.LOGGER_CLASS_KEY, clazz);
  58         // optional fields
  59         LogUtils.CUSTOM_MDC_MAP.put(LogUtils.OPTIONAL_LOG_SPEC_KEY, optionalLogSpec);
  60
  61         // log with normalized log level category
  62         LogUtils.logWithLogLevel(logLevelCategory, logger, LogUtils.METRIC_LOG_MARKER, message, args);
  63
  64         // clean up
  65         LogUtils.CUSTOM_MDC_MAP.remove(LogUtils.LOG_LEVEL_CATEGORY_KEY);
  66         LogUtils.CUSTOM_MDC_MAP.remove(LogUtils.METRIC_LOG_SPEC_KEY);
  67         LogUtils.CUSTOM_MDC_MAP.remove(LogUtils.LOGGER_CLASS_KEY);
  68         LogUtils.CUSTOM_MDC_MAP.remove(LogUtils.OPTIONAL_LOG_SPEC_KEY);
  69     }
  70
  71     @Override
  72     public void log(final LogLevelCategory logLevelCategory, final String message, final MetricLogSpec metricLogSpec,
  73                     final String... args) {
  74         log(logLevelCategory, message, metricLogSpec, null, args);
  75     }
  76
  77     @Override
  78     public void info(final String message, final MetricLogSpec metricLogSpec, final OptionalLogSpec optionalLogSpec,
  79                      final String... args) {
  80         log(LogLevelCategory.INFO, message, metricLogSpec, optionalLogSpec, args);
  81     }
  82
  83     @Override
  84     public void info(final String message, final MetricLogSpec metricLogSpec, final String... args) {
  85         log(LogLevelCategory.INFO, message, metricLogSpec, args);
  86     }
  87
  88     @Override
  89     public void warn(final String message, final MetricLogSpec metricLogSpec, final OptionalLogSpec optionalLogSpec,
  90                      final String... args) {
  91         log(LogLevelCategory.WARN, message, metricLogSpec, optionalLogSpec, args);
  92     }
  93
  94     @Override
  95     public void warn(final String message, final MetricLogSpec metricLogSpec, final String... args) {
  96         warn(message, metricLogSpec, null, args);
  97     }
  98
  99     @Override
 100     public void error(final String message, final MetricLogSpec metricLogSpec, final OptionalLogSpec optionalLogSpec,
 101                       final String... args) {
 102         log(LogLevelCategory.ERROR, message, metricLogSpec, optionalLogSpec, args);
 103     }
 104
 105     @Override
 106     public void error(final String message, final MetricLogSpec metricLogSpec, final String... args) {
 107         error(message, metricLogSpec, null, args);
 108     }
 109
 110     @Override
 111     public void fatal(final String message, final MetricLogSpec metricLogSpec, final OptionalLogSpec optionalLogSpec,
 112                       final String... args) {
 113         log(LogLevelCategory.FATAL, message, metricLogSpec, optionalLogSpec, args);
 114     }
 115
 116     @Override
 117     public void fatal(final String message, final MetricLogSpec metricLogSpec, final String... args) {
 118         fatal(message, metricLogSpec, null, args);
 119     }
 120 }