IGNITE-14353 Ability to specify application name for IgniteLogger (#9101

)

config/ignite-log4j2.xml

@@ -31,8 +31,8 @@
         <Routing name="FILE">
             <Routes pattern="$${sys:nodeId}">
                 <Route>
-                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}.log"
-                                 filePattern="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
+                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}.log"
+                                 filePattern="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
                         <PatternLayout pattern="[%d{ISO8601}][%-5p][%t][%c{1}]%notEmpty{[%markerSimpleName]} %m%n"/>
                         <Policies>
                             <TimeBasedTriggeringPolicy interval="6" modulate="true" />

config/java.util.logging.properties

@@ -68,7 +68,7 @@ java.util.logging.ConsoleHandler.level=INFO
 # under `$IGNITE_HOME/work/log/` directory. The placeholder `%{id8}` is a truncated node ID.
 #
 org.apache.ignite.logger.java.JavaLoggerFileHandler.formatter=org.apache.ignite.logger.java.JavaLoggerFormatter
-org.apache.ignite.logger.java.JavaLoggerFileHandler.pattern=ignite-%{id8}.%g.log
+org.apache.ignite.logger.java.JavaLoggerFileHandler.pattern=%{app}-%{id8}.%g.log
 org.apache.ignite.logger.java.JavaLoggerFileHandler.level=INFO
 org.apache.ignite.logger.java.JavaLoggerFileHandler.limit=10485760
 org.apache.ignite.logger.java.JavaLoggerFileHandler.count=10

docs/_docs/code-snippets/xml/log4j2-config.xml

@@ -29,8 +29,8 @@
         <Routing name="FILE">
             <Routes pattern="$${sys:nodeId}">
                 <Route>
-                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}.log"
-                                 filePattern="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
+                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}.log"
+                                 filePattern="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
                         <PatternLayout pattern="[%d{ISO8601}][%-5p][%t][%c{1}]%notEmpty{[%markerSimpleName]} %m%n"/>
                         <Policies>
                             <TimeBasedTriggeringPolicy interval="6" modulate="true" />

modules/core/src/main/java/org/apache/ignite/internal/IgnitionEx.java

@@ -109,6 +109,7 @@
 import org.apache.ignite.lang.IgniteBiInClosure;
 import org.apache.ignite.lang.IgniteBiTuple;
 import org.apache.ignite.lang.IgniteInClosure;
+import org.apache.ignite.logger.LoggerNodeIdAndApplicationAware;
 import org.apache.ignite.logger.LoggerNodeIdAware;
 import org.apache.ignite.logger.java.JavaLogger;
 import org.apache.ignite.marshaller.Marshaller;
@@ -2301,7 +2302,7 @@ private IgniteConfiguration initializeConfiguration(IgniteConfiguration cfg)
             if (!F.isEmpty(predefineConsistentId))
                 myCfg.setConsistentId(predefineConsistentId);
 
-            IgniteLogger cfgLog = initLogger(cfg.getGridLogger(), nodeId, workDir);
+            IgniteLogger cfgLog = initLogger(cfg.getGridLogger(), null, nodeId, workDir);
 
             assert cfgLog != null;
 
@@ -2565,7 +2566,7 @@ private void initializeDefaultSpi(IgniteConfiguration cfg) {
          * @throws IgniteCheckedException If failed.
          */
         @SuppressWarnings("ErrorNotRethrown")
-        private IgniteLogger initLogger(@Nullable IgniteLogger cfgLog, UUID nodeId, String workDir)
+        private IgniteLogger initLogger(@Nullable IgniteLogger cfgLog, @Nullable String app, UUID nodeId, String workDir)
             throws IgniteCheckedException {
             try {
                 Exception log4jInitErr = null;
@@ -2629,7 +2630,9 @@ private IgniteLogger initLogger(@Nullable IgniteLogger cfgLog, UUID nodeId, Stri
                     ((JavaLogger)cfgLog).setWorkDirectory(workDir);
 
                 // Set node IDs for all file appenders.
-                if (cfgLog instanceof LoggerNodeIdAware)
+                if (cfgLog instanceof LoggerNodeIdAndApplicationAware)
+                    ((LoggerNodeIdAndApplicationAware)cfgLog).setApplicationAndNode(app, nodeId);
+                else if (cfgLog instanceof LoggerNodeIdAware)
                     ((LoggerNodeIdAware)cfgLog).setNodeId(nodeId);
 
                 if (log4jInitErr != null)

modules/core/src/main/java/org/apache/ignite/logger/LoggerNodeIdAndApplicationAware.java

@@ -0,0 +1,39 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements.  See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.
+ */
+
+package org.apache.ignite.logger;
+
+import java.util.UUID;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * Interface for Ignite file appenders to attach postfix to log file names.
+ */
+public interface LoggerNodeIdAndApplicationAware extends LoggerNodeIdAware {
+    /** {@inheritDoc} */
+    @Override public default void setNodeId(UUID nodeId) {
+        setApplicationAndNode(null, nodeId);
+    }
+
+    /**
+     * Sets application name and node ID.
+     *
+     * @param application Application.
+     * @param nodeId Node ID.
+     */
+    public void setApplicationAndNode(@Nullable String application, UUID nodeId);
+}

modules/core/src/main/java/org/apache/ignite/logger/LoggerNodeIdAware.java

@@ -21,7 +21,10 @@
 
 /**
  * Interface for Ignite file appenders to attach node ID to log file names.
+ *
+ * @deprecated Use {@link LoggerNodeIdAndApplicationAware} instead.
  */
+@Deprecated
 public interface LoggerNodeIdAware {
     /**
      * Sets node ID.

modules/core/src/main/java/org/apache/ignite/logger/java/JavaLogger.java

@@ -34,7 +34,7 @@
 import org.apache.ignite.internal.util.typedef.internal.A;
 import org.apache.ignite.internal.util.typedef.internal.S;
 import org.apache.ignite.internal.util.typedef.internal.U;
-import org.apache.ignite.logger.LoggerNodeIdAware;
+import org.apache.ignite.logger.LoggerNodeIdAndApplicationAware;
 import org.jetbrains.annotations.Nullable;
 
 import static java.util.logging.Level.FINE;
@@ -95,7 +95,7 @@
  * logger in your task/job code. See {@link org.apache.ignite.resources.LoggerResource} annotation about logger
  * injection.
  */
-public class JavaLogger implements IgniteLogger, LoggerNodeIdAware {
+public class JavaLogger implements IgniteLogger, LoggerNodeIdAndApplicationAware {
     /** */
     public static final String DFLT_CONFIG_PATH = "config/java.util.logging.properties";
 
@@ -365,7 +365,7 @@ public void setWorkDirectory(String workDir) {
     }
 
     /** {@inheritDoc} */
-    @Override public void setNodeId(UUID nodeId) {
+    @Override public void setApplicationAndNode(@Nullable String application, UUID nodeId) {
         A.notNull(nodeId, "nodeId");
 
         if (this.nodeId != null)
@@ -385,7 +385,7 @@ public void setWorkDirectory(String workDir) {
             return;
 
         try {
-            fileHnd.nodeId(nodeId, workDir);
+            fileHnd.nodeId(application, nodeId, workDir);
         }
         catch (IgniteCheckedException | IOException e) {
             throw new RuntimeException("Failed to enable file handler.", e);

modules/core/src/main/java/org/apache/ignite/logger/java/JavaLoggerFileHandler.java

@@ -80,6 +80,16 @@ public final class JavaLoggerFileHandler extends StreamHandler {
      * @param nodeId Node id.
      */
     public void nodeId(UUID nodeId, String workDir) throws IgniteCheckedException, IOException {
+        nodeId(null, nodeId, workDir);
+    }
+
+    /**
+     * Sets Node id and instantiates {@link FileHandler} delegate.
+     *
+     * @param app Application name.
+     * @param nodeId Node id.
+     */
+    public void nodeId(@Nullable String app, UUID nodeId, String workDir) throws IgniteCheckedException, IOException {
         if (delegate != null)
             return;
 
@@ -88,9 +98,13 @@ public void nodeId(UUID nodeId, String workDir) throws IgniteCheckedException, I
         String ptrn = manager.getProperty(clsName + ".pattern");
 
         if (ptrn == null)
-            ptrn = "ignite-%{id8}.%g.log";
+            ptrn = "%{app}-%{id8}.%g.log";
+
+        String fileName = ptrn
+            .replace("%{app}", app != null ? app : "ignite")
+            .replace("%{id8}", U.id8(nodeId));
 
-        ptrn = new File(logDirectory(workDir), ptrn.replace("%{id8}", U.id8(nodeId))).getAbsolutePath();
+        ptrn = new File(logDirectory(workDir), fileName).getAbsolutePath();
 
         int limit = getIntProperty(clsName + ".limit", 0);
 

modules/core/src/test/config/log4j2-test.xml

@@ -31,8 +31,8 @@
         <Routing name="FILE">
             <Routes pattern="$${sys:nodeId}">
                 <Route>
-                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}.log"
-                                 filePattern="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
+                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}.log"
+                                 filePattern="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
                         <PatternLayout pattern="[%d{ISO8601}][%-5p][%t][%c{1}]%notEmpty{[%markerSimpleName]} %m%n"/>
                         <Policies>
                             <TimeBasedTriggeringPolicy interval="6" modulate="true" />

modules/core/src/test/config/log4j2-verbose-test.xml

@@ -26,8 +26,8 @@
         <Routing name="FILE">
             <Routes pattern="$${sys:nodeId}">
                 <Route>
-                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}.log"
-                                 filePattern="${sys:IGNITE_HOME}/work/log/ignite-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
+                    <RollingFile name="Rolling-${sys:nodeId}" fileName="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}.log"
+                                 filePattern="${sys:IGNITE_HOME}/work/log/${sys:appId}-${sys:nodeId}-%i-%d{yyyy-MM-dd}.log.gz">
                         <PatternLayout pattern="[%d{ISO8601}][%-5p][%t][%c{1}]%notEmpty{[%markerSimpleName]} %m%n"/>
                         <Policies>
                             <TimeBasedTriggeringPolicy interval="6" modulate="true" />

modules/core/src/test/java/org/apache/ignite/logger/java/JavaLoggerTest.java

@@ -20,7 +20,8 @@
 import java.util.UUID;
 import org.apache.ignite.IgniteLogger;
 import org.apache.ignite.internal.util.typedef.internal.U;
-import org.apache.ignite.logger.LoggerNodeIdAware;
+import org.apache.ignite.logger.LoggerNodeIdAndApplicationAware;
+import org.apache.ignite.testframework.GridTestUtils;
 import org.apache.ignite.testframework.junits.common.GridCommonTest;
 import org.junit.Test;
 
@@ -43,7 +44,7 @@ public void testLogInitialize() throws Exception {
         log = new JavaLogger();
 
         ((JavaLogger)log).setWorkDirectory(U.defaultWorkDirectory());
-        ((LoggerNodeIdAware)log).setNodeId(UUID.fromString("00000000-1111-2222-3333-444444444444"));
+        ((LoggerNodeIdAndApplicationAware)log).setApplicationAndNode(null, UUID.fromString("00000000-1111-2222-3333-444444444444"));
 
         System.out.println(log.toString());
 
@@ -67,5 +68,20 @@ public void testLogInitialize() throws Exception {
 
         // Ensure we don't get pattern, only actual file name is allowed here.
         assert !log.fileName().contains("%");
+        assert log.fileName().contains("ignite");
+
+        System.clearProperty("java.util.logging.config.file");
+        GridTestUtils.setFieldValue(JavaLogger.class, JavaLogger.class, "inited", false);
+
+        log = new JavaLogger();
+
+        ((JavaLogger)log).setWorkDirectory(U.defaultWorkDirectory());
+        ((LoggerNodeIdAndApplicationAware)log).setApplicationAndNode("other-app", UUID.fromString("00000000-1111-2222-3333-444444444444"));
+
+        assert log.fileName() != null;
+
+        // Ensure we don't get pattern, only actual file name is allowed here.
+        assert !log.fileName().contains("%");
+        assert log.fileName().contains("other-app");
     }
 }

modules/core/src/test/java/org/apache/ignite/testframework/junits/logger/GridLog4jRollingFileAppender.java

@@ -23,14 +23,15 @@
 import org.apache.ignite.IgniteSystemProperties;
 import org.apache.ignite.internal.util.typedef.internal.A;
 import org.apache.ignite.internal.util.typedef.internal.U;
-import org.apache.ignite.logger.LoggerNodeIdAware;
+import org.apache.ignite.logger.LoggerNodeIdAndApplicationAware;
 import org.apache.log4j.Layout;
 import org.apache.log4j.RollingFileAppender;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Log4J {@link org.apache.log4j.RollingFileAppender} with added support for grid node IDs.
  */
-public class GridLog4jRollingFileAppender extends RollingFileAppender implements LoggerNodeIdAware {
+public class GridLog4jRollingFileAppender extends RollingFileAppender implements LoggerNodeIdAndApplicationAware {
     /** Node ID. */
     private UUID nodeId;
 
@@ -79,8 +80,7 @@ private void init() {
     }
 
     /** {@inheritDoc} */
-    @SuppressWarnings("NonPrivateFieldAccessedInSynchronizedContext")
-    @Override public synchronized void setNodeId(UUID nodeId) {
+    @Override public synchronized void setApplicationAndNode(@Nullable String application, UUID nodeId) {
         A.notNull(nodeId, "nodeId");
 
         this.nodeId = nodeId;

modules/core/src/test/java/org/apache/ignite/testframework/junits/logger/GridTestLog4jLogger.java

@@ -33,7 +33,7 @@
 import org.apache.ignite.internal.util.typedef.internal.S;
 import org.apache.ignite.internal.util.typedef.internal.U;
 import org.apache.ignite.lang.IgniteClosure;
-import org.apache.ignite.logger.LoggerNodeIdAware;
+import org.apache.ignite.logger.LoggerNodeIdAndApplicationAware;
 import org.apache.log4j.Appender;
 import org.apache.log4j.Category;
 import org.apache.log4j.ConsoleAppender;
@@ -77,7 +77,7 @@
  * logger in your task/job code. See {@link org.apache.ignite.resources.LoggerResource} annotation about logger
  * injection.
  */
-public class GridTestLog4jLogger implements IgniteLogger, LoggerNodeIdAware {
+public class GridTestLog4jLogger implements IgniteLogger, LoggerNodeIdAndApplicationAware {
     /** Appenders. */
     private static Collection<FileAppender> fileAppenders = new GridConcurrentHashSet<>();
 
@@ -406,14 +406,14 @@ public static void removeAppender(FileAppender a) {
     }
 
     /** {@inheritDoc} */
-    @Override public void setNodeId(UUID nodeId) {
+    @Override public void setApplicationAndNode(@Nullable String application, UUID nodeId) {
         A.notNull(nodeId, "nodeId");
 
         this.nodeId = nodeId;
 
         for (FileAppender a : fileAppenders) {
-            if (a instanceof LoggerNodeIdAware) {
-                ((LoggerNodeIdAware)a).setNodeId(nodeId);
+            if (a instanceof LoggerNodeIdAndApplicationAware) {
+                ((LoggerNodeIdAndApplicationAware)a).setApplicationAndNode(application, nodeId);
 
                 a.activateOptions();
             }

modules/log4j/src/main/java/org/apache/ignite/logger/log4j/Log4JLogger.java

@@ -33,7 +33,7 @@
 import org.apache.ignite.internal.util.typedef.internal.S;
 import org.apache.ignite.internal.util.typedef.internal.U;
 import org.apache.ignite.lang.IgniteClosure;
-import org.apache.ignite.logger.LoggerNodeIdAware;
+import org.apache.ignite.logger.LoggerNodeIdAndApplicationAware;
 import org.apache.log4j.Appender;
 import org.apache.log4j.Category;
 import org.apache.log4j.ConsoleAppender;
@@ -79,7 +79,7 @@
  * logger in your task/job code. See {@link org.apache.ignite.resources.LoggerResource} annotation about logger
  * injection.
  */
-public class Log4JLogger implements IgniteLogger, LoggerNodeIdAware, Log4jFileAware {
+public class Log4JLogger implements IgniteLogger, LoggerNodeIdAndApplicationAware, Log4jFileAware {
     /** Appenders. */
     private static Collection<FileAppender> fileAppenders = new GridConcurrentHashSet<>();
 
@@ -500,12 +500,12 @@ public static void removeAppender(FileAppender a) {
     }
 
     /** {@inheritDoc} */
-    @Override public void setNodeId(UUID nodeId) {
+    @Override public void setApplicationAndNode(@Nullable String application, UUID nodeId) {
         A.notNull(nodeId, "nodeId");
 
         this.nodeId = nodeId;
 
-        updateFilePath(new Log4jNodeIdFilePath(nodeId));
+        updateFilePath(new Log4jNodeIdFilePath(application, nodeId));
     }
 
     /** {@inheritDoc} */

modules/log4j/src/main/java/org/apache/ignite/logger/log4j/Log4jNodeIdFilePath.java

@@ -23,6 +23,7 @@
 import org.apache.ignite.internal.util.typedef.F;
 import org.apache.ignite.internal.util.typedef.internal.U;
 import org.apache.ignite.lang.IgniteClosure;
+import org.jetbrains.annotations.Nullable;
 
 /**
  * Closure that generates file path adding node id to filename as a suffix.
@@ -31,30 +32,37 @@ class Log4jNodeIdFilePath implements IgniteClosure<String, String> {
     /** */
     private static final long serialVersionUID = 0L;
 
+    /** Applictaion name. */
+    private final @Nullable String app;
+
     /** Node id. */
     private final UUID nodeId;
 
     /**
      * Creates new instance.
      *
+     * @param app Application name.
      * @param id Node id.
      */
-    Log4jNodeIdFilePath(UUID id) {
+    Log4jNodeIdFilePath(@Nullable String app, UUID id) {
+        this.app = app;
         nodeId = id;
     }
 
     /** {@inheritDoc} */
     @Override public String apply(String oldPath) {
+        String fileName = (app != null ? app : "ignite") + ".log";
+
         if (!F.isEmpty(U.IGNITE_LOG_DIR))
-            return U.nodeIdLogFileName(nodeId, new File(U.IGNITE_LOG_DIR, "ignite.log").getAbsolutePath());
+            return U.nodeIdLogFileName(nodeId, new File(U.IGNITE_LOG_DIR, fileName).getAbsolutePath());
 
         if (oldPath != null) // fileName could be null if IGNITE_HOME is not defined.
             return U.nodeIdLogFileName(nodeId, oldPath);
 
         String tmpDir = IgniteSystemProperties.getString("java.io.tmpdir");
 
         if (tmpDir != null)
-            return U.nodeIdLogFileName(nodeId, new File(tmpDir, "ignite.log").getAbsolutePath());
+            return U.nodeIdLogFileName(nodeId, new File(tmpDir, fileName).getAbsolutePath());
 
         System.err.println("Failed to get tmp directory for log file.");