Skip to content
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

Jump to bottom

Added isIncludeContext check to access logger encoder. #393

Merged
merged 1 commit into from
Mar 4, 2020
Merged

Added isIncludeContext check to access logger encoder. #393

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
67 changes: 42 additions & 25 deletions src/main/java/net/logstash/logback/LogstashAccessFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
*/
package net.logstash.logback;

import ch.qos.logback.classic.spi.ILoggingEvent;
import net.logstash.logback.composite.ContextJsonProvider;
import net.logstash.logback.composite.FieldNamesAware;
import net.logstash.logback.composite.GlobalCustomFieldsJsonProvider;
Expand Down Expand Up @@ -46,24 +47,24 @@
/**
* A {@link AccessEventCompositeJsonFormatter} that contains a common
* pre-defined set of {@link JsonProvider}s.
*
*
* The included providers are configured via properties on this
* formatter, rather than configuring the providers directly.
* This leads to a somewhat simpler configuration definitions.
*
* This leads to a somewhat simpler configuration definitions.
*
* You cannot remove any of the pre-defined providers, but
* you can add additional providers via {@link #addProvider(JsonProvider)}.
*
*
* If you would like full control over the providers, you
* should instead use {@link AccessEventCompositeJsonFormatter} directly.
*/
public class LogstashAccessFormatter extends AccessEventCompositeJsonFormatter {

/**
* The field names to use when writing the access event fields
*/
protected LogstashAccessFieldNames fieldNames = new LogstashAccessFieldNames();

private final AccessEventFormattedTimestampJsonProvider timestampProvider = new AccessEventFormattedTimestampJsonProvider();
private final LogstashVersionJsonProvider<IAccessEvent> versionProvider = new LogstashVersionJsonProvider<IAccessEvent>();
private final AccessMessageJsonProvider messageProvider = new AccessMessageJsonProvider();
Expand All @@ -78,12 +79,12 @@ public class LogstashAccessFormatter extends AccessEventCompositeJsonFormatter {
private final ElapsedTimeJsonProvider elapsedTimeProvider = new ElapsedTimeJsonProvider();
private final RequestHeadersJsonProvider requestHeadersProvider = new RequestHeadersJsonProvider();
private final ResponseHeadersJsonProvider responseHeadersProvider = new ResponseHeadersJsonProvider();
private final ContextJsonProvider<IAccessEvent> contextProvider = new ContextJsonProvider<IAccessEvent>();
private ContextJsonProvider<IAccessEvent> contextProvider = new ContextJsonProvider<IAccessEvent>();
private GlobalCustomFieldsJsonProvider<IAccessEvent> globalCustomFieldsProvider;

public LogstashAccessFormatter(ContextAware declaredOrigin) {
super(declaredOrigin);

getProviders().addTimestamp(this.timestampProvider);
getProviders().addVersion(this.versionProvider);
getProviders().addAccessMessage(this.messageProvider);
Expand All @@ -100,7 +101,7 @@ public LogstashAccessFormatter(ContextAware declaredOrigin) {
getProviders().addResponseHeaders(this.responseHeadersProvider);
getProviders().addContext(this.contextProvider);
}

@Override
public void start() {
configureProviderFieldNames();
Expand All @@ -119,12 +120,12 @@ protected void configureProviderFieldNames() {
public void addProvider(JsonProvider<IAccessEvent> provider) {
getProviders().addProvider(provider);
}

@Override
public AccessEventJsonProviders getProviders() {
return (AccessEventJsonProviders) super.getProviders();
}

public LogstashAccessFieldNames getFieldNames() {
return fieldNames;
}
Expand All @@ -139,7 +140,7 @@ public String getTimeZone() {
public void setTimeZone(String timeZoneId) {
this.timestampProvider.setTimeZone(timeZoneId);
this.messageProvider.setTimeZone(timeZoneId);
}
}
public String getTimestampPattern() {
return timestampProvider.getPattern();
}
Expand All @@ -152,7 +153,7 @@ public String getCustomFieldsAsString() {
? null
: globalCustomFieldsProvider.getCustomFields();
}

public void setCustomFieldsFromString(String customFields) {
if (customFields == null || customFields.length() == 0) {
getProviders().removeProvider(globalCustomFieldsProvider);
Expand All @@ -164,7 +165,7 @@ public void setCustomFieldsFromString(String customFields) {
globalCustomFieldsProvider.setCustomFields(customFields);
}
}

public void setCustomFields(JsonNode customFields) {
if (customFields == null) {
getProviders().removeProvider(globalCustomFieldsProvider);
Expand All @@ -176,13 +177,13 @@ public void setCustomFields(JsonNode customFields) {
globalCustomFieldsProvider.setCustomFieldsNode(customFields);
}
}

public JsonNode getCustomFields() {
return globalCustomFieldsProvider == null
? null
: globalCustomFieldsProvider.getCustomFieldsNode();
}

public boolean getLowerCaseHeaderNames() {
return this.requestHeadersProvider.getLowerCaseHeaderNames();
}
Expand All @@ -195,33 +196,49 @@ public void setLowerCaseHeaderNames(boolean lowerCaseHeaderNames) {
this.requestHeadersProvider.setLowerCaseHeaderNames(lowerCaseHeaderNames);
this.responseHeadersProvider.setLowerCaseHeaderNames(lowerCaseHeaderNames);
}

public HeaderFilter getRequestHeaderFilter() {
return this.requestHeadersProvider.getFilter();
}

@DefaultClass(IncludeExcludeHeaderFilter.class)
public void setRequestHeaderFilter(HeaderFilter filter) {
this.requestHeadersProvider.setFilter(filter);
}

public HeaderFilter getResponseHeaderFilter() {
return this.responseHeadersProvider.getFilter();
}

@DefaultClass(IncludeExcludeHeaderFilter.class)
public void setResponseHeaderFilter(HeaderFilter filter) {
this.responseHeadersProvider.setFilter(filter);
}


public boolean isIncludeContext() {
return contextProvider != null;
}

public void setIncludeContext(boolean includeContext) {
if (isIncludeContext() != includeContext) {
getProviders().removeProvider(contextProvider);
if (includeContext) {
contextProvider = new ContextJsonProvider<IAccessEvent>();
getProviders().addContext(contextProvider);
} else {
contextProvider = null;
}
}
}

public String getVersion() {
return this.versionProvider.getVersion();
}
public void setVersion(String version) {
this.versionProvider.setVersion(version);
}


/**
* @deprecated Use {@link #isWriteVersionAsInteger()}
* @return true if the version should be written as a string
Expand All @@ -238,14 +255,14 @@ public boolean isWriteVersionAsString() {
public void setWriteVersionAsString(boolean writeVersionAsString) {
this.versionProvider.setWriteAsString(writeVersionAsString);
}

public boolean isWriteVersionAsInteger() {
return this.versionProvider.isWriteAsInteger();
}
public void setWriteVersionAsInteger(boolean writeVersionAsInteger) {
this.versionProvider.setWriteAsInteger(writeVersionAsInteger);
}


@Override
public void setProviders(JsonProviders<IAccessEvent> jsonProviders) {
Expand Down
39 changes: 23 additions & 16 deletions src/main/java/net/logstash/logback/encoder/LogstashAccessEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@
import ch.qos.logback.core.joran.spi.DefaultClass;

public class LogstashAccessEncoder extends AccessEventCompositeJsonEncoder {

@Override
protected CompositeJsonFormatter<IAccessEvent> createFormatter() {
return new LogstashAccessFormatter(this);
}

@Override
protected LogstashAccessFormatter getFormatter() {
return (LogstashAccessFormatter) super.getFormatter();
Expand All @@ -41,7 +41,7 @@ public void addProvider(JsonProvider<IAccessEvent> provider) {
public LogstashAccessFieldNames getFieldNames() {
return getFormatter().getFieldNames();
}

public void setFieldNames(LogstashAccessFieldNames fieldNames) {
getFormatter().setFieldNames(fieldNames);
}
Expand All @@ -53,59 +53,66 @@ public String getTimeZone() {
public void setTimeZone(String timeZoneId) {
getFormatter().setTimeZone(timeZoneId);
}

public String getTimestampPattern() {
return getFormatter().getTimestampPattern();
}
public void setTimestampPattern(String pattern) {
getFormatter().setTimestampPattern(pattern);
}

public void setCustomFields(String customFields) {
getFormatter().setCustomFieldsFromString(customFields);
}

public String getCustomFields() {
return getFormatter().getCustomFieldsAsString();
}

public boolean getLowerCaseHeaderNames() {
return getFormatter().getLowerCaseHeaderNames();
}

/**
* When true, names of headers will be written to JSON output in lowercase.
* When true, names of headers will be written to JSON output in lowercase.
*/
public void setLowerCaseHeaderNames(boolean lowerCaseHeaderNames) {
getFormatter().setLowerCaseHeaderNames(lowerCaseHeaderNames);
}

public HeaderFilter getRequestHeaderFilter() {
return getFormatter().getRequestHeaderFilter();
}

@DefaultClass(IncludeExcludeHeaderFilter.class)
public void setRequestHeaderFilter(HeaderFilter filter) {
getFormatter().setRequestHeaderFilter(filter);
}

public HeaderFilter getResponseHeaderFilter() {
return getFormatter().getResponseHeaderFilter();
}

@DefaultClass(IncludeExcludeHeaderFilter.class)
public void setResponseHeaderFilter(HeaderFilter filter) {
getFormatter().setResponseHeaderFilter(filter);
}


public boolean isIncludeContext() {
return getFormatter().isIncludeContext();
}

public void setIncludeContext(boolean includeContext) {
getFormatter().setIncludeContext(includeContext);
}

public String getVersion() {
return getFormatter().getVersion();
}
public void setVersion(String version) {
getFormatter().setVersion(version);
}


/**
* @deprecated Use {@link #isWriteVersionAsInteger()}
*/
Expand All @@ -120,12 +127,12 @@ public boolean isWriteVersionAsString() {
public void setWriteVersionAsString(boolean writeVersionAsString) {
getFormatter().setWriteVersionAsString(writeVersionAsString);
}

public boolean isWriteVersionAsInteger() {
return getFormatter().isWriteVersionAsInteger();
}
public void setWriteVersionAsInteger(boolean writeVersionAsInteger) {
getFormatter().setWriteVersionAsInteger(writeVersionAsInteger);
}

}
Loading