Skip to content

[fix](log) Support fe log rollover size strategy #34446

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
dataroaring merged 2 commits into from
May 9, 2024
Merged

[fix](log) Support fe log rollover size strategy #34446

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1320c97
[fix](log) Compatible logging strategy for cloud and non-cloud
deardeng May 6, 2024
a3aeb24
fix review
deardeng May 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions fe/fe-common/src/main/java/org/apache/doris/common/Config.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2612,6 +2612,12 @@ public class Config extends ConfigBase {
//==========================================================================
// begin of cloud config
//==========================================================================
@ConfField(description = {"是否启用FE 日志文件按照大小删除策略，当日志大小超过指定大小，删除相关的log。默认为按照时间策略删除",
"Whether to enable the FE log file deletion policy based on size, "
+ "where logs exceeding the specified size are deleted. "
+ "It is disabled by default and follows a time-based deletion policy."},
options = {"age", "size"})
public static String log_rollover_strategy = "age";

@ConfField public static int info_sys_accumulated_file_size = 4;
@ConfField public static int warn_sys_accumulated_file_size = 2;
Expand Down
172 changes: 96 additions & 76 deletions fe/fe-core/src/main/java/org/apache/doris/common/Log4jConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,81 +39,101 @@
public class Log4jConfig extends XmlConfiguration {
private static final long serialVersionUID = 1L;

// CHECKSTYLE OFF
private static String xmlConfTemplate = "<?xml version=\"1.0\" encoding=\"utf-8\"?>\n"
+ "\n<!-- Auto Generated. DO NOT MODIFY IT! -->\n"
+ "<Configuration status=\"info\" packages=\"org.apache.doris.common\">\n"
+ " <Appenders>\n"
+ " <Console name=\"Console\" target=\"SYSTEM_OUT\">"
+ " <PatternLayout charset=\"UTF-8\">\n"
+ " <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} %p (%t|%tid)<!--REPLACED BY LOG FORMAT-->%m%n</Pattern>\n"
+ " </PatternLayout>\n"
+ " </Console>"
+ " <RollingFile name=\"Sys\" fileName=\"${sys_log_dir}/fe.log\" filePattern=\"${sys_log_dir}/fe.log.${sys_file_pattern}-%i${sys_file_postfix}\" immediateFlush=\"${immediate_flush_flag}\">\n"
+ " <PatternLayout charset=\"UTF-8\">\n"
+ " <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} %p (%t|%tid)<!--REPLACED BY LOG FORMAT-->%m%n</Pattern>\n"
+ " </PatternLayout>\n"
+ " <Policies>\n"
+ " <TimeBasedTriggeringPolicy/>\n"
+ " <SizeBasedTriggeringPolicy size=\"${sys_roll_maxsize}MB\"/>\n"
+ " </Policies>\n"
+ " <DefaultRolloverStrategy max=\"${sys_roll_num}\" fileIndex=\"max\">\n"
+ " <Delete basePath=\"${sys_log_dir}/\" maxDepth=\"1\">\n"
+ " <IfFileName glob=\"fe.log.*\" />\n"
+ " <IfAny>\n"
+ " <IfAccumulatedFileSize exceeds=\"${info_sys_accumulated_file_size}GB\"/>\n"
+ " </IfAny>\n"
+ " </Delete>\n"
+ " </DefaultRolloverStrategy>\n"
+ " </RollingFile>\n"
+ " <RollingFile name=\"SysWF\" fileName=\"${sys_log_dir}/fe.warn.log\" filePattern=\"${sys_log_dir}/fe.warn.log.${sys_file_pattern}-%i${sys_file_postfix}\" immediateFlush=\"${immediate_flush_flag}\">\n"
+ " <PatternLayout charset=\"UTF-8\">\n"
+ " <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} %p (%t|%tid)<!--REPLACED BY LOG FORMAT-->%m%n</Pattern>\n"
+ " </PatternLayout>\n"
+ " <Policies>\n"
+ " <TimeBasedTriggeringPolicy/>\n"
+ " <SizeBasedTriggeringPolicy size=\"${sys_roll_maxsize}MB\"/>\n"
+ " </Policies>\n"
+ " <DefaultRolloverStrategy max=\"${sys_roll_num}\" fileIndex=\"max\">\n"
+ " <Delete basePath=\"${sys_log_dir}/\" maxDepth=\"1\">\n"
+ " <IfFileName glob=\"fe.warn.log.*\" />\n"
+ " <IfAny>\n"
+ " <IfAccumulatedFileSize exceeds=\"${warn_sys_accumulated_file_size}GB\"/>\n"
+ " </IfAny>\n"
+ " </Delete>\n"
+ " </DefaultRolloverStrategy>\n"
+ " </RollingFile>\n"
+ " <RollingFile name=\"Auditfile\" fileName=\"${audit_log_dir}/fe.audit.log\" filePattern=\"${audit_log_dir}/fe.audit.log.${audit_file_pattern}-%i${audit_file_postfix}\">\n"
+ " <PatternLayout charset=\"UTF-8\">\n"
+ " <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} [%c{1}] %m%n</Pattern>\n"
+ " </PatternLayout>\n"
+ " <Policies>\n"
+ " <TimeBasedTriggeringPolicy/>\n"
+ " <SizeBasedTriggeringPolicy size=\"${audit_roll_maxsize}MB\"/>\n"
+ " </Policies>\n"
+ " <DefaultRolloverStrategy max=\"${audit_roll_num}\" fileIndex=\"max\">\n"
+ " <Delete basePath=\"${audit_log_dir}/\" maxDepth=\"1\">\n"
+ " <IfFileName glob=\"fe.audit.log.*\" />\n"
+ " <IfAny>\n"
+ " <IfAccumulatedFileSize exceeds=\"${audit_sys_accumulated_file_size}GB\"/>\n"
+ " </IfAny>\n"
+ " </Delete>\n"
+ " </DefaultRolloverStrategy>\n"
+ " </RollingFile>\n"
+ " </Appenders>\n"
+ " <Loggers>\n"
+ " <Root level=\"${sys_log_level}\" includeLocation=\"${include_location_flag}\">\n"
+ " <AppenderRef ref=\"Sys\"/>\n"
+ " <AppenderRef ref=\"SysWF\" level=\"WARN\"/>\n"
+ " <!--REPLACED BY Console Logger-->\n"
+ " </Root>\n"
+ " <Logger name=\"audit\" level=\"ERROR\" additivity=\"false\">\n"
+ " <AppenderRef ref=\"Auditfile\"/>\n"
+ " </Logger>\n"
+ " <!--REPLACED BY AUDIT AND VERBOSE MODULE NAMES-->\n"
+ " </Loggers>\n"
+ "</Configuration>";
// CHECKSTYLE ON
private static StringBuilder xmlConfTemplateBuilder = new StringBuilder();

private static void getXmlConfByStrategy(final String size, final String age) {
if (Config.log_rollover_strategy.equalsIgnoreCase("size")) {
xmlConfTemplateBuilder
.append(" <IfAny>\n")
.append(" <IfAccumulatedFileSize exceeds=\"${").append(size).append("}GB\"/>\n")
.append(" </IfAny>\n");
} else {
// default age
xmlConfTemplateBuilder
.append(" <IfLastModified age=\"${").append(age).append("}\" />\n");
}
}

static {
// CHECKSTYLE OFF
xmlConfTemplateBuilder.append("<?xml version=\"1.0\" encoding=\"utf-8\"?>\n")
.append("\n<!-- Auto Generated. DO NOT MODIFY IT! -->\n")
.append("<Configuration status=\"info\" packages=\"org.apache.doris.common\">\n")
.append(" <Appenders>\n")
.append(" <Console name=\"Console\" target=\"SYSTEM_OUT\">")
.append(" <PatternLayout charset=\"UTF-8\">\n")
.append(" <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} %p (%t|%tid)<!--REPLACED BY LOG FORMAT-->%m%n</Pattern>\n")
.append(" </PatternLayout>\n")
.append(" </Console>\n")
.append(" <RollingFile name=\"Sys\" fileName=\"${sys_log_dir}/fe.log\" filePattern=\"${sys_log_dir}/fe.log.${sys_file_pattern}-%i${sys_file_postfix}\" immediateFlush=\"${immediate_flush_flag}\">\n")
.append(" <PatternLayout charset=\"UTF-8\">\n")
.append(" <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} %p (%t|%tid)<!--REPLACED BY LOG FORMAT-->%m%n</Pattern>\n")
.append(" </PatternLayout>\n")
.append(" <Policies>\n")
.append(" <TimeBasedTriggeringPolicy/>\n")
.append(" <SizeBasedTriggeringPolicy size=\"${sys_roll_maxsize}MB\"/>\n")
.append(" </Policies>\n")
.append(" <DefaultRolloverStrategy max=\"${sys_roll_num}\" fileIndex=\"max\">\n")
.append(" <Delete basePath=\"${sys_log_dir}/\" maxDepth=\"1\">\n")
.append(" <IfFileName glob=\"fe.log.*\" />\n");

getXmlConfByStrategy("info_sys_accumulated_file_size", "sys_log_delete_age");

xmlConfTemplateBuilder
.append(" </Delete>\n")
.append(" </DefaultRolloverStrategy>\n")
.append(" </RollingFile>\n")
.append(" <RollingFile name=\"SysWF\" fileName=\"${sys_log_dir}/fe.warn.log\" filePattern=\"${sys_log_dir}/fe.warn.log.${sys_file_pattern}-%i${sys_file_postfix}\" immediateFlush=\"${immediate_flush_flag}\">\n")
.append(" <PatternLayout charset=\"UTF-8\">\n")
.append(" <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} %p (%t|%tid)<!--REPLACED BY LOG FORMAT-->%m%n</Pattern>\n")
.append(" </PatternLayout>\n")
.append(" <Policies>\n")
.append(" <TimeBasedTriggeringPolicy/>\n")
.append(" <SizeBasedTriggeringPolicy size=\"${sys_roll_maxsize}MB\"/>\n")
.append(" </Policies>\n")
.append(" <DefaultRolloverStrategy max=\"${sys_roll_num}\" fileIndex=\"max\">\n")
.append(" <Delete basePath=\"${sys_log_dir}/\" maxDepth=\"1\">\n")
.append(" <IfFileName glob=\"fe.warn.log.*\" />\n");

getXmlConfByStrategy("warn_sys_accumulated_file_size", "sys_log_delete_age");

xmlConfTemplateBuilder
.append(" </Delete>\n")
.append(" </DefaultRolloverStrategy>\n")
.append(" </RollingFile>\n")
.append(" <RollingFile name=\"Auditfile\" fileName=\"${audit_log_dir}/fe.audit.log\" filePattern=\"${audit_log_dir}/fe.audit.log.${audit_file_pattern}-%i${audit_file_postfix}\">\n")
.append(" <PatternLayout charset=\"UTF-8\">\n")
.append(" <Pattern>%d{yyyy-MM-dd HH:mm:ss,SSS} [%c{1}] %m%n</Pattern>\n")
.append(" </PatternLayout>\n")
.append(" <Policies>\n")
.append(" <TimeBasedTriggeringPolicy/>\n")
.append(" <SizeBasedTriggeringPolicy size=\"${audit_roll_maxsize}MB\"/>\n")
.append(" </Policies>\n")
.append(" <DefaultRolloverStrategy max=\"${audit_roll_num}\" fileIndex=\"max\">\n")
.append(" <Delete basePath=\"${audit_log_dir}/\" maxDepth=\"1\">\n")
.append(" <IfFileName glob=\"fe.audit.log.*\" />\n");

getXmlConfByStrategy("audit_sys_accumulated_file_size", "audit_log_delete_age");

xmlConfTemplateBuilder
.append(" </Delete>\n")
.append(" </DefaultRolloverStrategy>\n")
.append(" </RollingFile>\n")
.append(" </Appenders>\n")
.append(" <Loggers>\n")
.append(" <Root level=\"${sys_log_level}\" includeLocation=\"${include_location_flag}\">\n")
.append(" <AppenderRef ref=\"Sys\"/>\n")
.append(" <AppenderRef ref=\"SysWF\" level=\"WARN\"/>\n")
.append(" <!--REPLACED BY Console Logger-->\n")
.append(" </Root>\n")
.append(" <Logger name=\"audit\" level=\"ERROR\" additivity=\"false\">\n")
.append(" <AppenderRef ref=\"Auditfile\"/>\n")
.append(" </Logger>\n")
.append(" <!--REPLACED BY AUDIT AND VERBOSE MODULE NAMES-->\n")
.append(" </Loggers>\n")
.append("</Configuration>");
// CHECKSTYLE ON
}

private static StrSubstitutor strSub;
private static String sysLogLevel;
Expand All @@ -134,7 +154,7 @@ public class Log4jConfig extends XmlConfiguration {
public static boolean foreground = false;

private static void reconfig() throws IOException {
String newXmlConfTemplate = xmlConfTemplate;
String newXmlConfTemplate = xmlConfTemplateBuilder.toString();

// sys log config
// ATTN, sys_log_dir is deprecated, use LOG_DIR instead
Expand Down