fix(docker): enable docker logs for pd/store/server containers (#2980)

* fix(docker): wire console appender to AsyncLogger for hugegraph server

Author: bitflicker64

hugegraph-pd/Dockerfile

@@ -35,7 +35,8 @@ LABEL maintainer="HugeGraph Docker Maintainers <dev@hugegraph.apache.org>"
 
 # TODO: use g1gc or zgc as default
 ENV JAVA_OPTS="-XX:+UnlockExperimentalVMOptions -XX:+UseContainerSupport -XX:MaxRAMPercentage=50 -XshowSettings:vm" \
-    HUGEGRAPH_HOME="hugegraph-pd"
+    HUGEGRAPH_HOME="hugegraph-pd" \
+    STDOUT_MODE="true"
 
 #COPY . /hugegraph/hugegraph-pd
 WORKDIR /hugegraph-pd/

hugegraph-pd/hg-pd-dist/src/assembly/static/bin/start-hugegraph-pd.sh

@@ -168,8 +168,13 @@ echo "Starting HugeGraphPDServer..."
 JVM_OPTIONS="-Dlog4j.configurationFile=${CONF}/log4j2.xml -Djava.util.logging.manager=org.apache.logging.log4j.jul.LogManager"
 
 # Turn on security check
-exec ${JAVA} -Dname="HugeGraphPD" ${JVM_OPTIONS} ${JAVA_OPTIONS} -jar \
-    -Dspring.config.location=${CONF}/application.yml ${LIB}/hg-pd-service-*.jar >> ${OUTPUT} 2>&1 &
+if [[ "${STDOUT_MODE:-false}" == "true" ]]; then
+    exec ${JAVA} -Dname="HugeGraphPD" ${JVM_OPTIONS} ${JAVA_OPTIONS} -jar \
+        -Dspring.config.location=${CONF}/application.yml ${LIB}/hg-pd-service-*.jar &
+else
+    exec ${JAVA} -Dname="HugeGraphPD" ${JVM_OPTIONS} ${JAVA_OPTIONS} -jar \
+        -Dspring.config.location=${CONF}/application.yml ${LIB}/hg-pd-service-*.jar >> ${OUTPUT} 2>&1 &
+fi
 
 PID="$!"
 # Write pid to file

hugegraph-pd/hg-pd-dist/src/assembly/static/conf/log4j2.xml

@@ -115,6 +115,7 @@
 
     <loggers>
         <root level="INFO">
+            <appender-ref ref="console" />
             <appender-ref ref="file" />
         </root>
         <logger name="com.alipay.sofa" level="INFO" additivity="false">

hugegraph-server/Dockerfile

@@ -36,7 +36,8 @@ LABEL maintainer="HugeGraph Docker Maintainers <dev@hugegraph.apache.org>"
 # TODO: use g1gc or zgc as default
 # Note: --add-exports is required for Java 11+ to access jdk.internal.reflect for auth proxy
 ENV JAVA_OPTS="-XX:+UnlockExperimentalVMOptions -XX:+UseContainerSupport -XX:MaxRAMPercentage=50 -XshowSettings:vm --add-exports=java.base/jdk.internal.reflect=ALL-UNNAMED" \
-    HUGEGRAPH_HOME="hugegraph-server"
+    HUGEGRAPH_HOME="hugegraph-server" \
+    STDOUT_MODE="true"
 
 #COPY . /hugegraph/hugegraph-server
 WORKDIR /hugegraph-server/

hugegraph-server/hugegraph-dist/src/assembly/static/bin/hugegraph-server.sh

@@ -183,6 +183,11 @@ if [ "${OPEN_TELEMETRY}" == "true" ]; then
 fi
 
 # Turn on security check
-exec ${JAVA} -Dname="HugeGraphServer" ${JVM_OPTIONS} ${JAVA_OPTIONS} -cp ${CLASSPATH}: \
-    org.apache.hugegraph.dist.HugeGraphServer ${GREMLIN_SERVER_CONF} ${REST_SERVER_CONF} \
-    >> ${OUTPUT} 2>&1
+if [[ "${STDOUT_MODE:-false}" == "true" ]]; then
+    exec ${JAVA} -Dname="HugeGraphServer" ${JVM_OPTIONS} ${JAVA_OPTIONS} -cp ${CLASSPATH}: \
+        org.apache.hugegraph.dist.HugeGraphServer ${GREMLIN_SERVER_CONF} ${REST_SERVER_CONF}
+else
+    exec ${JAVA} -Dname="HugeGraphServer" ${JVM_OPTIONS} ${JAVA_OPTIONS} -cp ${CLASSPATH}: \
+        org.apache.hugegraph.dist.HugeGraphServer ${GREMLIN_SERVER_CONF} ${REST_SERVER_CONF} \
+        >> ${LOGS}/hugegraph-server-stdout.log 2>&1
+fi

hugegraph-server/hugegraph-dist/src/assembly/static/bin/start-hugegraph.sh

@@ -99,17 +99,14 @@ if [[ $PRELOAD == "true" ]]; then
     sed -i -e '/registerBackends/d; /serverStarted/d' "${SCRIPTS}/${EXAMPLE_SCRIPT}"
 fi
 
-# TODO: show the output message in hugegraph-server.sh when start the server
 if [[ $DAEMON == "true" ]]; then
     echo "Starting HugeGraphServer in daemon mode..."
     "${BIN}"/hugegraph-server.sh "${CONF}/${GREMLIN_SERVER_CONF}" "${CONF}"/rest-server.properties \
-    "${OPEN_SECURITY_CHECK}" "${USER_OPTION}" "${GC_OPTION}" "${OPEN_TELEMETRY}" \
-    >>"${LOGS}"/hugegraph-server.log 2>&1 &
+    "${OPEN_SECURITY_CHECK}" "${USER_OPTION}" "${GC_OPTION}" "${OPEN_TELEMETRY}" &
 else
     echo "Starting HugeGraphServer in foreground mode..."
     "${BIN}"/hugegraph-server.sh "${CONF}/${GREMLIN_SERVER_CONF}" "${CONF}"/rest-server.properties \
-    "${OPEN_SECURITY_CHECK}" "${USER_OPTION}" "${GC_OPTION}" "${OPEN_TELEMETRY}" \
-    >>"${LOGS}"/hugegraph-server.log 2>&1
+    "${OPEN_SECURITY_CHECK}" "${USER_OPTION}" "${GC_OPTION}" "${OPEN_TELEMETRY}"
 fi
 
 PID="$!"
@@ -119,7 +116,11 @@ echo "$PID" > "$PID_FILE"
 trap 'kill $PID; exit' SIGHUP SIGINT SIGQUIT SIGTERM
 
 wait_for_startup ${PID} 'HugeGraphServer' "$REST_SERVER_URL/graphs" "${SERVER_STARTUP_TIMEOUT_S}" || {
-    echo "See $LOGS/hugegraph-server.log for HugeGraphServer log output." >&2
+    if [[ "${STDOUT_MODE:-false}" == "true" ]]; then
+        echo "See 'docker logs' for HugeGraphServer log output." >&2
+    else
+        echo "See $LOGS/hugegraph-server.log for HugeGraphServer log output." >&2
+    fi
     if [[ $DAEMON == "true" ]]; then
         exit 1
     fi

hugegraph-server/hugegraph-dist/src/assembly/static/conf/log4j2.xml

@@ -104,6 +104,7 @@
 
     <loggers>
         <root level="INFO">
+            <appender-ref ref="console"/>
             <appender-ref ref="file"/>
         </root>
         <logger name="org.apache.cassandra" level="INFO" additivity="false">
@@ -129,6 +130,7 @@
         </logger>
         <!-- Use mixed async way to output logs -->
         <AsyncLogger name="org.apache.hugegraph" level="INFO" additivity="false">
+            <appender-ref ref="console"/>
             <appender-ref ref="file"/>
         </AsyncLogger>
         <AsyncLogger name="org.apache.hugegraph.auth" level="INFO" additivity="false">

hugegraph-store/Dockerfile

@@ -35,7 +35,8 @@ LABEL maintainer="HugeGraph Docker Maintainers <dev@hugegraph.apache.org>"
 
 # TODO: use g1gc or zgc as default
 ENV JAVA_OPTS="-XX:+UnlockExperimentalVMOptions -XX:+UseContainerSupport -XX:MaxRAMPercentage=50 -XshowSettings:vm" \
-    HUGEGRAPH_HOME="hugegraph-store"
+    HUGEGRAPH_HOME="hugegraph-store" \
+    STDOUT_MODE="true"
 
 #COPY . /hugegraph/hugegraph-store
 WORKDIR /hugegraph-store/

hugegraph-store/hg-store-dist/src/assembly/static/bin/start-hugegraph-store.sh

@@ -221,9 +221,16 @@ fi
 
 echo "Starting HG-StoreServer..."
 
-exec ${JAVA} -Dname="HugeGraphStore" ${JVM_OPTIONS} ${JAVA_OPTIONS} -jar \
-    -Dspring.config.location=${CONF}/application.yml \
-    ${LIB}/hg-store-node-*.jar >> ${OUTPUT} 2>&1 &
+# Turn on security check
+if [[ "${STDOUT_MODE:-false}" == "true" ]]; then
+    exec ${JAVA} -Dname="HugeGraphStore" ${JVM_OPTIONS} ${JAVA_OPTIONS} -jar \
+        -Dspring.config.location=${CONF}/application.yml \
+        ${LIB}/hg-store-node-*.jar &
+else
+    exec ${JAVA} -Dname="HugeGraphStore" ${JVM_OPTIONS} ${JAVA_OPTIONS} -jar \
+        -Dspring.config.location=${CONF}/application.yml \
+        ${LIB}/hg-store-node-*.jar >> ${OUTPUT} 2>&1 &
+fi
 
 PID="$!"
 # Write pid to file

hugegraph-store/hg-store-dist/src/assembly/static/conf/log4j2.xml

@@ -117,6 +117,7 @@
 
     <loggers>
         <root level="INFO">
+            <appender-ref ref="console"/>
             <appender-ref ref="file"/>
         </root>
         <logger name="com.alipay.sofa" level="INFO" additivity="false">