Skip to content

Fix/log4j routing to avoid create spurious file #12965

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
andsel merged 5 commits into from
Jun 16, 2021
Merged

Fix/log4j routing to avoid create spurious file #12965

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d49c739
[WIP] Remove the properties of routing instead of work on the configu…
andsel May 27, 2021
6a9fd79
Revert "[WIP] Remove the properties of routing instead of work on the…
andsel Jun 4, 2021
863069c
Skip pipeline appender creation when the log event context doesn't th…
andsel Jun 4, 2021
db3f9bf
Added spec to proove there isn't any spurious log files
andsel Jun 15, 2021
f78a1e6
Minor, documented why return null in routing appender
andsel Jun 15, 2021
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
8 changes: 6 additions & 2 deletions logstash-core/src/main/java/org/logstash/log/PipelineRoutingAppender.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import org.apache.logging.log4j.core.Appender;
import org.apache.logging.log4j.core.Core;
import org.apache.logging.log4j.core.Filter;
import org.apache.logging.log4j.core.LogEvent;
import org.apache.logging.log4j.core.appender.AbstractAppender;
import org.apache.logging.log4j.core.config.AppenderControl;
Expand Down Expand Up @@ -107,8 +108,11 @@ public void append(LogEvent event) {
private AppenderControl getControl(LogEvent event) {
String key = event.getContextData().getValue("pipeline.id");
if (key == null) {
error("Unable to find the pipeline.id in event's context data");
key = "sink";
LOGGER.debug("Unable to find the pipeline.id in event's context data in routing appender, skip it");
// this prevent to create an appender when log events are not fish-tagged with pipeline.id,
// avoid to create log file like "pipeline_${ctx:pipeline.id}.log" which contains duplicated
// logs from the logstash-* files
return null;
}

AppenderControl appenderControl = createdAppenders.get(key);
Expand Down
2 changes: 1 addition & 1 deletion logstash-core/src/main/java/org/logstash/log/PipelineRoutingFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
@Plugin(name = "PipelineRoutingFilter", category = Core.CATEGORY_NAME, elementType = Appender.ELEMENT_TYPE, printObject = true)
public final class PipelineRoutingFilter extends AbstractFilter {

private boolean isSeparateLogs;
private final boolean isSeparateLogs;

/**
* Factory method to instantiate the filter
Expand Down
2 changes: 2 additions & 0 deletions qa/integration/build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,8 @@ tasks.register("copyProductionLog4jConfiguration", Copy) {
'appender.rolling.policies.size.size = 1KB')
.replace('appender.rolling.filePattern = ${sys:ls.logs}/logstash-plain-%d{yyyy-MM-dd}-%i.log.gz',
'appender.rolling.filePattern = ${sys:ls.logs}/logstash-plain-%d{yyyy-MM-dd}.log')
.replace('appender.routing.pipeline.policy.size = 100MB',
'appender.routing.pipeline.policy.size = 1KB')
}
}

Expand Down
23 changes: 23 additions & 0 deletions qa/integration/specs/pipeline_log_spec.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,6 +142,29 @@
end
end

it "rollover of pipeline log file when pipeline.separate_logs is enabled shouldn't create spurious file " do
pipeline_name = "custom_pipeline"
settings = {
"path.logs" => temp_dir,
"pipeline.id" => pipeline_name,
"pipeline.separate_logs" => true
}
FileUtils.mkdir_p(File.join(temp_dir, "data"))
data = File.join(temp_dir, "data")
settings = settings.merge({ "path.data" => data })
IO.write(File.join(temp_dir, "logstash.yml"), YAML.dump(settings))

log_definition = File.read('fixtures/logs_rollover/log4j2.properties')
expect(log_definition).to match(/appender\.routing\.pipeline\.policy\.size\s*=\s*1KB/)
FileUtils.cp("fixtures/logs_rollover/log4j2.properties", temp_dir)

@ls.spawn_logstash("--path.settings", temp_dir, "-w", "1" , "-e", config)
wait_logstash_process_terminate(@ls)

pipeline_logs = Dir.glob("pipeline*.log", base: temp_dir)
expect(pipeline_logs).not_to include("pipeline_${ctx:pipeline.id}.log")
end

it "should not create separate pipelines log files if not enabled" do
pipeline_name = "custom_pipeline"
settings = {
Expand Down