1 files changed, 130 insertions, 0 deletions
diff --git a/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java
new file mode 100644
index 0000000..ebc33ca
--- /dev/null
+++ b/eelf-logger/eelf-logger-api/src/main/java/org/onap/dcae/utils/eelf/logger/api/log/MetricLog.java
@@ -0,0 +1,130 @@
+/*
+ * ================================================================================
+ * Copyright (c) 2018 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ *
+ */
+
+package org.onap.dcae.utils.eelf.logger.api.log;
+
+
+import org.onap.dcae.utils.eelf.logger.api.info.LogLevelCategory;
+import org.onap.dcae.utils.eelf.logger.api.spec.MetricLogSpec;
+import org.onap.dcae.utils.eelf.logger.api.spec.OptionalLogSpec;
+
+/**
+ * Metric Log captures all log levels supported by metric specifications
+ *
+ * @author Rajiv Singla
+ */
+public interface MetricLog {
+
+    /**
+     * Logs metric message with provided {@link LogLevelCategory}
+     *
+     * @param logLevelCategory log level category
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param optionalLogSpec optional log spec
+     * @param args argument values for log message interpolation
+     */
+    void log(LogLevelCategory logLevelCategory, String message, MetricLogSpec metricLogSpec,
+             OptionalLogSpec optionalLogSpec, String... args);
+
+    /**
+     * Logs metric message with provided {@link LogLevelCategory} and with default {@link OptionalLogSpec}
+     *
+     * @param logLevelCategory log level category
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void log(LogLevelCategory logLevelCategory, String message, MetricLogSpec metricLogSpec, String... args);
+
+
+    /**
+     * Logs metric message with provided INFO {@link LogLevelCategory}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void info(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);
+
+    /**
+     * Logs metric message with provided INFO {@link LogLevelCategory} and with default {@link OptionalLogSpec}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void info(String message, MetricLogSpec metricLogSpec, String... args);
+
+
+    /**
+     * Logs metric message with provided WARN {@link LogLevelCategory}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void warn(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);
+
+    /**
+     * Logs metric message with provided WARN {@link LogLevelCategory} and with default {@link OptionalLogSpec}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void warn(String message, MetricLogSpec metricLogSpec, String... args);
+
+    /**
+     * Logs metric message with provided ERROR {@link LogLevelCategory}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void error(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);
+
+    /**
+     * Logs metric message with provided ERROR {@link LogLevelCategory} and with default {@link OptionalLogSpec}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void error(String message, MetricLogSpec metricLogSpec, String... args);
+
+    /**
+     * Logs metric message with provided FATAL {@link LogLevelCategory}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void fatal(String message, MetricLogSpec metricLogSpec, OptionalLogSpec optionalLogSpec, String... args);
+
+    /**
+     * Logs metric message with provided FATAL {@link LogLevelCategory} and with default {@link OptionalLogSpec}
+     *
+     * @param message log message
+     * @param metricLogSpec metric log spec
+     * @param args argument values for log message interpolation
+     */
+    void fatal(String message, MetricLogSpec metricLogSpec, String... args);
+
+}