[#11758] Separate banner into module

agent-module/bootstraps/bootstrap/src/main/java/com/navercorp/pinpoint/bootstrap/PinpointStarter.java

@@ -17,7 +17,6 @@
 import com.navercorp.pinpoint.ProductInfo;
 import com.navercorp.pinpoint.bootstrap.agentdir.AgentDirectory;
 import com.navercorp.pinpoint.bootstrap.agentdir.LogDirCleaner;
-import com.navercorp.pinpoint.bootstrap.banner.PinpointBannerImpl;
 import com.navercorp.pinpoint.bootstrap.classloader.PinpointClassLoaderFactory;
 import com.navercorp.pinpoint.bootstrap.classloader.ProfilerLibs;
 import com.navercorp.pinpoint.bootstrap.config.DefaultProfilerConfig;
@@ -26,7 +25,6 @@
 import com.navercorp.pinpoint.bootstrap.config.PropertyLoader;
 import com.navercorp.pinpoint.bootstrap.config.PropertyLoaderFactory;
 import com.navercorp.pinpoint.common.Version;
-import com.navercorp.pinpoint.common.banner.PinpointBanner;
 import com.navercorp.pinpoint.common.util.OsEnvSimpleProperty;
 import com.navercorp.pinpoint.common.util.PropertySnapshot;
 import com.navercorp.pinpoint.common.util.SimpleProperty;
@@ -152,11 +150,6 @@ boolean start() {
             pinpointAgent.registerStopHandler();
 
             logger.info("pinpoint agent started normally.");
-
-            final PinpointBannerImpl banner = new PinpointBannerImpl(profilerConfig.readList("pinpoint.banner.configs"), logger);
-            banner.setPinpointBannerMode(PinpointBanner.Mode.valueOf(profilerConfig.readString("pinpoint.banner.mode", "CONSOLE").toUpperCase()));
-            banner.setPinpointBannerProperty(properties);
-            banner.printBanner();
         } catch (Exception e) {
             // unexpected exception that did not be checked above
             logger.warn(ProductInfo.NAME + " start failed.", e);

agent-module/profiler/pom.xml

@@ -38,6 +38,10 @@
             <groupId>com.navercorp.pinpoint</groupId>
             <artifactId>pinpoint-annotations</artifactId>
         </dependency>
+        <dependency>
+            <groupId>com.navercorp.pinpoint</groupId>
+            <artifactId>pinpoint-banner</artifactId>
+        </dependency>
         <dependency>
             <groupId>com.navercorp.pinpoint</groupId>
             <artifactId>pinpoint-commons</artifactId>

agent-module/profiler/src/main/java/com/navercorp/pinpoint/profiler/DefaultAgent.java

@@ -17,6 +17,9 @@
 package com.navercorp.pinpoint.profiler;
 
 import com.navercorp.pinpoint.ProductInfo;
+import com.navercorp.pinpoint.banner.Banner;
+import com.navercorp.pinpoint.banner.Mode;
+import com.navercorp.pinpoint.banner.PinpointBanner;
 import com.navercorp.pinpoint.bootstrap.Agent;
 import com.navercorp.pinpoint.bootstrap.AgentOption;
 import com.navercorp.pinpoint.bootstrap.config.ProfilerConfig;
@@ -37,6 +40,7 @@
 
 import java.nio.file.Path;
 import java.nio.file.Paths;
+import java.util.List;
 import java.util.Map;
 import java.util.Objects;
 import java.util.Properties;
@@ -158,8 +162,18 @@ public void start() {
                 return;
             }
         }
+
         logger.info("Starting {} Agent.", ProductInfo.NAME);
         this.applicationContext.start();
+        printBanner();
+    }
+
+    private void printBanner() {
+        List<String> dumpKeys = profilerConfig.readList("pinpoint.banner.configs");
+        Mode mode = Mode.valueOf(profilerConfig.readString("pinpoint.banner.mode", "CONSOLE").toUpperCase());
+        Properties properties = profilerConfig.getProperties();
+        final Banner banner = new PinpointBanner(mode, dumpKeys, properties::getProperty, logger::info);
+        banner.printBanner();
     }
 
     @Override

banner/README.md

@@ -0,0 +1 @@
+# pinpoint-banner

banner/pom.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
+    <modelVersion>4.0.0</modelVersion>
+    <parent>
+        <groupId>com.navercorp.pinpoint</groupId>
+        <artifactId>pinpoint</artifactId>
+        <version>3.1.0-SNAPSHOT</version>
+    </parent>
+
+    <artifactId>pinpoint-banner</artifactId>
+    <packaging>jar</packaging>
+
+    <dependencies>
+
+        <!-- Logging dependencies -->
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-api</artifactId>
+            <scope>test</scope>
+        </dependency>
+        <dependency>
+            <groupId>org.apache.logging.log4j</groupId>
+            <artifactId>log4j-core</artifactId>
+            <scope>test</scope>
+        </dependency>
+
+
+    </dependencies>
+
+    <build>
+        <plugins>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>templating-maven-plugin</artifactId>
+            </plugin>
+        </plugins>
+    </build>
+</project>

banner/src/main/java-templates/com/navercorp/pinpoint/banner/BannerVersionTemplate.java

@@ -0,0 +1,5 @@
+package com.navercorp.pinpoint.banner;
+
+class BannerVersionTemplate {
+    static final String VERSION = "${project.version}";
+}

banner/src/main/java/com/navercorp/pinpoint/banner/Banner.java

@@ -0,0 +1,5 @@
+package com.navercorp.pinpoint.banner;
+
+public interface Banner {
+    void printBanner();
+}

banner/src/main/java/com/navercorp/pinpoint/banner/BannerUtils.java

@@ -0,0 +1,37 @@
+package com.navercorp.pinpoint.banner;
+
+import java.io.BufferedReader;
+import java.io.IOException;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.io.Reader;
+import java.nio.charset.Charset;
+import java.nio.charset.StandardCharsets;
+
+class BannerUtils {
+
+    static String readAllString(InputStream inputStream, Charset charset) throws IOException {
+        try (Reader inputStreamReader = new InputStreamReader(inputStream, charset);
+             BufferedReader bufferedReader = new BufferedReader(inputStreamReader)) {
+            StringBuilder buffer = new StringBuilder(64);
+            String line;
+            while ((line = bufferedReader.readLine()) != null) {
+                buffer.append(line);
+                buffer.append(System.lineSeparator());
+            }
+            return buffer.toString();
+        }
+    }
+
+    static String banner() {
+        return banner("/pinpoint-banner/banner.txt");
+    }
+
+    private static String banner(String bannerFile) {
+        try (InputStream inputStream = BannerUtils.class.getResourceAsStream(bannerFile)) {
+            return BannerUtils.readAllString(inputStream, StandardCharsets.UTF_8);
+        } catch (IOException e) {
+            throw new RuntimeException("banner IO failed", e);
+        }
+    }
+}

banner/src/main/java/com/navercorp/pinpoint/banner/Mode.java

@@ -0,0 +1,7 @@
+package com.navercorp.pinpoint.banner;
+
+public enum Mode {
+    OFF,
+    CONSOLE,
+    LOG;
+}

banner/src/main/java/com/navercorp/pinpoint/banner/PinpointBanner.java

@@ -0,0 +1,59 @@
+package com.navercorp.pinpoint.banner;
+
+import java.util.Collection;
+import java.util.Objects;
+import java.util.function.Consumer;
+import java.util.function.Function;
+
+public class PinpointBanner implements Banner {
+    private final Mode bannerMode;
+    private final Collection<String> dumpKeys;
+    private final Function<String, String> properties;
+    private final Consumer<String> consoleWriter = System.out::println;
+    private final Consumer<String> loggerWriter;
+
+    public PinpointBanner(Mode bannerMode,
+                          Collection<String> dumpKeys,
+                          Function<String, String> properties,
+                          Consumer<String> loggerWriter) {
+        this.bannerMode = Objects.requireNonNull(bannerMode, "bannerMode");
+        this.dumpKeys = Objects.requireNonNull(dumpKeys, "dumpKeys");
+        this.properties = Objects.requireNonNull(properties, "properties");
+        this.loggerWriter = Objects.requireNonNull(loggerWriter, "loggerWriter");
+    }
+
+
+    @Override
+    public void printBanner() {
+        switch (bannerMode) {
+            case OFF:
+                return;
+            case LOG:
+                loggerWriter.accept(buildBannerString());
+                return;
+            default:
+                consoleWriter.accept(buildBannerString());
+        }
+    }
+
+    private String buildBannerString() {
+        StringBuilder banner = new StringBuilder(128);
+        banner.append(BannerUtils.banner());
+        banner.append(format("Pinpoint Version", BannerVersionTemplate.VERSION));
+        banner.append(System.lineSeparator());
+
+        for (String key : dumpKeys) {
+            String value = properties.apply(key);
+            if (value != null) {
+                banner.append(format(key, value));
+                banner.append(System.lineSeparator());
+            }
+        }
+        return banner.toString();
+    }
+
+    protected String format(String key, String value) {
+        return String.format(" :: %55s :: %35s", key, value);
+    }
+
+}

banner/src/main/resources/pinpoint-banner/banner.txt

@@ -0,0 +1,9 @@
+
+        88888888ba   88  888b      88  88888888ba     ,ad8888ba,    88  888b      88  888888888888
+        88      ,8P  88  88 `8b    88  88      ,8P  d8'        `8b  88  88 `8b    88       88
+        88aaaaaa8P'  88  88  `8b   88  88aaaaaa8P'  88    da    88  88  88  `8b   88       88
+        88           88  88    `8b 88  88           Y8,        ,8P  88  88    `8b 88       88
+        88           88  88      `888  88             `"Y8888Y"'    88  88      `888       88
+
+                               https://github.com/pinpoint-apm/pinpoint
+

banner/src/test/java/com/navercorp/pinpoint/banner/BannerUtilsTest.java

@@ -0,0 +1,19 @@
+package com.navercorp.pinpoint.banner;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.junit.jupiter.api.Test;
+
+
+class BannerUtilsTest {
+    private final Logger logger = LogManager.getLogger(this.getClass());
+
+    @Test
+    void banner() {
+        String banner = BannerUtils.banner();
+        logger.debug("--------");
+        logger.debug(banner);
+        logger.debug("--------");
+    }
+
+}

banner/src/test/java/com/navercorp/pinpoint/banner/PinpointBannerTest.java

@@ -0,0 +1,32 @@
+package com.navercorp.pinpoint.banner;
+
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
+import org.junit.jupiter.api.Test;
+
+import java.util.Collections;
+import java.util.Enumeration;
+import java.util.List;
+import java.util.Properties;
+
+class PinpointBannerTest {
+    private final Logger logger = LogManager.getLogger(this.getClass());
+
+    @Test
+    void printBanner() {
+        Properties properties = new Properties();
+        properties.put("aaa", "111");
+        properties.put("bbb", "222");
+        List<String> dumpKeys = keyList(properties);
+
+        Banner banner = new PinpointBanner(Mode.LOG, dumpKeys,
+                properties::getProperty, logger::info);
+        banner.printBanner();
+    }
+
+    private List<String> keyList(Properties properties) {
+        @SuppressWarnings("unchecked")
+        Enumeration<String> enumeration = (Enumeration<String>) properties.propertyNames();
+        return Collections.list(enumeration);
+    }
+}

banner/src/test/resources/log4j2-test.xml

@@ -0,0 +1,23 @@
+<?xml version="1.0" encoding="utf-8"?>
+<Configuration status="INFO">
+    <Properties>
+        <Property name="console_message_pattern">%d{MM-dd HH:mm:ss.sss} [%15.15t] %clr{%-5level} %clr{%-40.40logger{1.}}{cyan}:%3L -- %msg{nolookups}%n</Property>
+        <Property name="file_message_pattern">%d{MM-dd HH:mm:ss.sss} [%15.15t] %-5level %-40.40logger{1.}:%3L -- %msg{nolookups}%n</Property>
+    </Properties>
+
+    <Appenders>
+        <Console name="console" target="system_out">
+            <PatternLayout pattern="${file_message_pattern}"/>
+        </Console>
+    </Appenders>
+
+    <Loggers>
+         <Logger name="com.navercorp.pinpoint" level="DEBUG" additivity="false">
+            <AppenderRef ref="console"/>
+        </Logger>
+
+        <Root level="DEBUG">
+            <AppenderRef ref="console"/>
+        </Root>
+    </Loggers>
+</Configuration>