Skip to content

Remove deprecated includeCallerInfo #543

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
merged 1 commit into from
Jun 26, 2021
Merged

Remove deprecated includeCallerInfo #543

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
26 changes: 4 additions & 22 deletions src/main/java/net/logstash/logback/LogstashFormatter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,16 +100,16 @@ public LogstashFormatter(ContextAware declaredOrigin) {
this(declaredOrigin, false);
}

public LogstashFormatter(ContextAware declaredOrigin, boolean includeCallerInfo) {
this(declaredOrigin, includeCallerInfo, null);
public LogstashFormatter(ContextAware declaredOrigin, boolean includeCallerData) {
this(declaredOrigin, includeCallerData, null);
}

public LogstashFormatter(ContextAware declaredOrigin, boolean includeCallerInfo, JsonNode customFields) {
public LogstashFormatter(ContextAware declaredOrigin, boolean includeCallerData, JsonNode customFields) {
super(declaredOrigin);

this.fieldNames = new LogstashFieldNames();

setIncludeCallerInfo(includeCallerInfo);
setIncludeCallerData(includeCallerData);
setCustomFields(customFields);

getProviders().addTimestamp(this.timestampProvider);
Expand Down Expand Up @@ -160,24 +160,6 @@ public void setIncludeCallerData(boolean includeCallerData) {
}
}

/**
* @deprecated use {@link #isIncludeCallerData()} (to use the same name that logback uses)
* @return true if the caller info should be included
*/
@Deprecated
public boolean isIncludeCallerInfo() {
return isIncludeCallerData();
}

/**
* @deprecated use {@link #setIncludeCallerData(boolean)} (to use the same name that logback uses)
* @param includeCallerInfo true if the caller info should be included
*/
@Deprecated
public void setIncludeCallerInfo(boolean includeCallerInfo) {
setIncludeCallerData(includeCallerInfo);
}

public String getCustomFieldsAsString() {
return globalCustomFieldsProvider == null
? null
Expand Down
16 changes: 0 additions & 16 deletions src/main/java/net/logstash/logback/encoder/LogstashEncoder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,22 +48,6 @@ public void setIncludeCallerData(boolean includeCallerData) {
getFormatter().setIncludeCallerData(includeCallerData);
}

/**
* @deprecated use {@link #isIncludeCallerData()} (to use the same name that logback uses)
*/
@Deprecated
public boolean isIncludeCallerInfo() {
return getFormatter().isIncludeCallerInfo();
}

/**
* @deprecated use {@link #setIncludeCallerData(boolean)} (to use the same name that logback uses)
*/
@Deprecated
public void setIncludeCallerInfo(boolean includeCallerInfo) {
getFormatter().setIncludeCallerInfo(includeCallerInfo);
}

public void setCustomFields(String customFields) {
getFormatter().setCustomFieldsFromString(customFields);
}
Expand Down
16 changes: 0 additions & 16 deletions src/main/java/net/logstash/logback/layout/LogstashLayout.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,22 +54,6 @@ public void setIncludeCallerData(boolean includeCallerData) {
getFormatter().setIncludeCallerData(includeCallerData);
}

/**
* @deprecated use {@link #isIncludeCallerData()} (to use the same name that logback uses)
*/
@Deprecated
public boolean isIncludeCallerInfo() {
return getFormatter().isIncludeCallerInfo();
}

/**
* @deprecated use {@link #setIncludeCallerData(boolean)} (to use the same name that logback uses)
*/
@Deprecated
public void setIncludeCallerInfo(boolean includeCallerInfo) {
getFormatter().setIncludeCallerInfo(includeCallerInfo);
}

public LogstashFieldNames getFieldNames() {
return getFormatter().getFieldNames();
}
Expand Down
6 changes: 3 additions & 3 deletions src/test/java/net/logstash/logback/encoder/LogstashEncoderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ public void callerDataIsIncluded() throws Exception {
final StackTraceElement[] stackTraceElements = { new StackTraceElement("caller_class", "method_name", "file_name", 12345) };
when(event.getCallerData()).thenReturn(stackTraceElements);

encoder.setIncludeCallerInfo(true);
encoder.setIncludeCallerData(true);

encoder.start();
byte[] encoded = encoder.encode(event);
Expand All @@ -334,7 +334,7 @@ public void callerDataIsIncludedInSubObject() throws Exception {
final StackTraceElement[] stackTraceElements = { new StackTraceElement("caller_class", "method_name", "file_name", 12345) };
when(event.getCallerData()).thenReturn(stackTraceElements);

encoder.setIncludeCallerInfo(true);
encoder.setIncludeCallerData(true);
encoder.getFieldNames().setCaller("caller");
encoder.start();
byte[] encoded = encoder.encode(event);
Expand All @@ -355,7 +355,7 @@ public void callerDataIsNotIncludedIfSwitchedOff() throws Exception {
when(event.getFormattedMessage()).thenReturn("My message");
when(event.getLevel()).thenReturn(Level.ERROR);
when(event.getMDCPropertyMap()).thenReturn(Collections.emptyMap());
encoder.setIncludeCallerInfo(false);
encoder.setIncludeCallerData(false);

encoder.start();
byte[] encoded = encoder.encode(event);
Expand Down
2 changes: 1 addition & 1 deletion src/test/resources/logback-test.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@
<callerFile>file</callerFile>
<callerLine>line</callerLine>
</fieldNames>
<includeCallerInfo>true</includeCallerInfo>
<includeCallerData>true</includeCallerData>
<enableContextMap>true</enableContextMap>
<shortenedLoggerNameLength>20</shortenedLoggerNameLength>
<throwableConverter class="net.logstash.logback.stacktrace.ShortenedThrowableConverter">
Expand Down