Spring/spring-framework
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

Improve logging for Servlet / Reactive Streams adapters

Browse Source 
See gh-26434
This commit is contained in:
Rossen Stoyanchev
2021-03-04 13:42:29 +00:00
parent d23a108e76
commit 42e4ca1e2d
6 changed files with 84 additions and 50 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerReadPublisher.java
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2019 the original author or authors. * Copyright 2002-2021 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -123,18 +123,22 @@ public abstract class AbstractListenerReadPublisher<T> implements Publisher<T> {
* all data has been read. * all data has been read.
*/ */
public void onAllDataRead() { public void onAllDataRead() {
rsReadLogger.trace(getLogPrefix() + "onAllDataRead"); State state = this.state.get();
this.state.get().onAllDataRead(this); if (rsReadLogger.isTraceEnabled()) {
rsReadLogger.trace(getLogPrefix() + "onAllDataRead [" + state + "]");
}
state.onAllDataRead(this);
} }
/** /**
* Sub-classes can call this to delegate container error notifications. * Sub-classes can call this to delegate container error notifications.
*/ */
public final void onError(Throwable ex) { public final void onError(Throwable ex) {
State state = this.state.get();
if (rsReadLogger.isTraceEnabled()) { if (rsReadLogger.isTraceEnabled()) {
rsReadLogger.trace(getLogPrefix() + "Connection error: " + ex); rsReadLogger.trace(getLogPrefix() + "onError: " + ex + " [" + state + "]");
} }
this.state.get().onError(this, ex); state.onError(this, ex);
} }
@@ -191,13 +195,13 @@ public abstract class AbstractListenerReadPublisher<T> implements Publisher<T> {
Subscriber<? super T> subscriber = this.subscriber; Subscriber<? super T> subscriber = this.subscriber;
Assert.state(subscriber != null, "No subscriber"); Assert.state(subscriber != null, "No subscriber");
if (rsReadLogger.isTraceEnabled()) { if (rsReadLogger.isTraceEnabled()) {
rsReadLogger.trace(getLogPrefix() + "Publishing data read"); rsReadLogger.trace(getLogPrefix() + "Publishing " + data.getClass().getSimpleName());
} }
subscriber.onNext(data); subscriber.onNext(data);
} }
else { else {
if (rsReadLogger.isTraceEnabled()) { if (rsReadLogger.isTraceEnabled()) {
rsReadLogger.trace(getLogPrefix() + "No more data to read"); rsReadLogger.trace(getLogPrefix() + "No more to read");
} }
return true; return true;
} }
@@ -255,17 +259,18 @@ public abstract class AbstractListenerReadPublisher<T> implements Publisher<T> {
@Override @Override
public final void request(long n) { public final void request(long n) {
if (rsReadLogger.isTraceEnabled()) { if (rsReadLogger.isTraceEnabled()) {
rsReadLogger.trace(getLogPrefix() + n + " requested"); rsReadLogger.trace(getLogPrefix() + "request " + (n != Long.MAX_VALUE ? n : "Long.MAX_VALUE"));
} }
state.get().request(AbstractListenerReadPublisher.this, n); state.get().request(AbstractListenerReadPublisher.this, n);
} }
@Override @Override
public final void cancel() { public final void cancel() {
State state = AbstractListenerReadPublisher.this.state.get();
if (rsReadLogger.isTraceEnabled()) { if (rsReadLogger.isTraceEnabled()) {
rsReadLogger.trace(getLogPrefix() + "Cancellation"); rsReadLogger.trace(getLogPrefix() + "cancel [" + state + "]");
} }
state.get().cancel(AbstractListenerReadPublisher.this); state.cancel(AbstractListenerReadPublisher.this);
} }
} }

34
spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteFlushProcessor.java
View File

@@ -75,7 +75,7 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
*/ */
public AbstractListenerWriteFlushProcessor(String logPrefix) { public AbstractListenerWriteFlushProcessor(String logPrefix) {
this.logPrefix = logPrefix; this.logPrefix = logPrefix;
this.resultPublisher = new WriteResultPublisher(logPrefix); this.resultPublisher = new WriteResultPublisher(logPrefix + "[WFP] ");
} }
@@ -98,7 +98,7 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
@Override @Override
public final void onNext(Publisher<? extends T> publisher) { public final void onNext(Publisher<? extends T> publisher) {
if (rsWriteFlushLogger.isTraceEnabled()) { if (rsWriteFlushLogger.isTraceEnabled()) {
rsWriteFlushLogger.trace(getLogPrefix() + "Received onNext publisher"); rsWriteFlushLogger.trace(getLogPrefix() + "onNext: \"write\" Publisher");
} }
this.state.get().onNext(this, publisher); this.state.get().onNext(this, publisher);
} }
@@ -109,10 +109,11 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
*/ */
@Override @Override
public final void onError(Throwable ex) { public final void onError(Throwable ex) {
State state = this.state.get();
if (rsWriteFlushLogger.isTraceEnabled()) { if (rsWriteFlushLogger.isTraceEnabled()) {
rsWriteFlushLogger.trace(getLogPrefix() + "Received onError: " + ex); rsWriteFlushLogger.trace(getLogPrefix() + "onError: " + ex + " [" + state + "]");
} }
this.state.get().onError(this, ex); state.onError(this, ex);
} }
/** /**
@@ -121,10 +122,11 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
*/ */
@Override @Override
public final void onComplete() { public final void onComplete() {
State state = this.state.get();
if (rsWriteFlushLogger.isTraceEnabled()) { if (rsWriteFlushLogger.isTraceEnabled()) {
rsWriteFlushLogger.trace(getLogPrefix() + "Received onComplete"); rsWriteFlushLogger.trace(getLogPrefix() + "onComplete [" + state + "]");
} }
this.state.get().onComplete(this); state.onComplete(this);
} }
/** /**
@@ -142,7 +144,7 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
*/ */
protected void cancel() { protected void cancel() {
if (rsWriteFlushLogger.isTraceEnabled()) { if (rsWriteFlushLogger.isTraceEnabled()) {
rsWriteFlushLogger.trace(getLogPrefix() + "Received request to cancel"); rsWriteFlushLogger.trace(getLogPrefix() + "cancel [" + this.state + "]");
} }
if (this.subscription != null) { if (this.subscription != null) {
this.subscription.cancel(); this.subscription.cancel();
@@ -294,7 +296,7 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
} }
if (processor.changeState(this, REQUESTED)) { if (processor.changeState(this, REQUESTED)) {
if (processor.sourceCompleted) { if (processor.sourceCompleted) {
handleSubscriberCompleted(processor); handleSourceCompleted(processor);
} }
else { else {
Assert.state(processor.subscription != null, "No subscription"); Assert.state(processor.subscription != null, "No subscription");
@@ -307,11 +309,11 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
processor.sourceCompleted = true; processor.sourceCompleted = true;
// A competing write might have completed very quickly // A competing write might have completed very quickly
if (processor.state.get().equals(State.REQUESTED)) { if (processor.state.get().equals(State.REQUESTED)) {
handleSubscriberCompleted(processor); handleSourceCompleted(processor);
} }
} }
private <T> void handleSubscriberCompleted(AbstractListenerWriteFlushProcessor<T> processor) { private <T> void handleSourceCompleted(AbstractListenerWriteFlushProcessor<T> processor) {
if (processor.isFlushPending()) { if (processor.isFlushPending()) {
// Ensure the final flush // Ensure the final flush
processor.changeState(State.REQUESTED, State.FLUSHING); processor.changeState(State.REQUESTED, State.FLUSHING);
@@ -423,6 +425,10 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
@Override @Override
public void onError(Throwable ex) { public void onError(Throwable ex) {
if (rsWriteFlushLogger.isTraceEnabled()) {
rsWriteFlushLogger.trace(
this.processor.getLogPrefix() + "current \"write\" Publisher failed: " + ex);
}
this.processor.cancel(); this.processor.cancel();
this.processor.onError(ex); this.processor.onError(ex);
} }
@@ -430,10 +436,16 @@ public abstract class AbstractListenerWriteFlushProcessor<T> implements Processo
@Override @Override
public void onComplete() { public void onComplete() {
if (rsWriteFlushLogger.isTraceEnabled()) { if (rsWriteFlushLogger.isTraceEnabled()) {
rsWriteFlushLogger.trace(this.processor.getLogPrefix() + this.processor.state + " writeComplete"); rsWriteFlushLogger.trace(
this.processor.getLogPrefix() + "current \"write\" Publisher completed");
} }
this.processor.state.get().writeComplete(this.processor); this.processor.state.get().writeComplete(this.processor);
} }
@Override
public String toString() {
return this.processor.getClass().getSimpleName() + "-WriteResultSubscriber";
}
} }
} }

20
spring-web/src/main/java/org/springframework/http/server/reactive/AbstractListenerWriteProcessor.java
View File

@@ -89,7 +89,7 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
*/ */
public AbstractListenerWriteProcessor(String logPrefix) { public AbstractListenerWriteProcessor(String logPrefix) {
this.logPrefix = (StringUtils.hasText(logPrefix) ? logPrefix : ""); this.logPrefix = (StringUtils.hasText(logPrefix) ? logPrefix : "");
this.resultPublisher = new WriteResultPublisher(logPrefix); this.resultPublisher = new WriteResultPublisher(logPrefix + "[WP] ");
} }
@@ -112,7 +112,7 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
@Override @Override
public final void onNext(T data) { public final void onNext(T data) {
if (rsWriteLogger.isTraceEnabled()) { if (rsWriteLogger.isTraceEnabled()) {
rsWriteLogger.trace(getLogPrefix() + "Item to write"); rsWriteLogger.trace(getLogPrefix() + "onNext: " + data.getClass().getSimpleName());
} }
this.state.get().onNext(this, data); this.state.get().onNext(this, data);
} }
@@ -123,10 +123,11 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
*/ */
@Override @Override
public final void onError(Throwable ex) { public final void onError(Throwable ex) {
State state = this.state.get();
if (rsWriteLogger.isTraceEnabled()) { if (rsWriteLogger.isTraceEnabled()) {
rsWriteLogger.trace(getLogPrefix() + "Write source error: " + ex); rsWriteLogger.trace(getLogPrefix() + "onError: " + ex + " [" + state + "]");
} }
this.state.get().onError(this, ex); state.onError(this, ex);
} }
/** /**
@@ -135,10 +136,11 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
*/ */
@Override @Override
public final void onComplete() { public final void onComplete() {
State state = this.state.get();
if (rsWriteLogger.isTraceEnabled()) { if (rsWriteLogger.isTraceEnabled()) {
rsWriteLogger.trace(getLogPrefix() + "No more items to write"); rsWriteLogger.trace(getLogPrefix() + "onComplete [" + state + "]");
} }
this.state.get().onComplete(this); state.onComplete(this);
} }
/** /**
@@ -158,7 +160,9 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
* container to cancel the upstream subscription. * container to cancel the upstream subscription.
*/ */
public void cancel() { public void cancel() {
rsWriteLogger.trace(getLogPrefix() + "Cancellation"); if (rsWriteLogger.isTraceEnabled()) {
rsWriteLogger.trace(getLogPrefix() + "cancel [" + this.state + "]");
}
if (this.subscription != null) { if (this.subscription != null) {
this.subscription.cancel(); this.subscription.cancel();
} }
@@ -287,7 +291,7 @@ public abstract class AbstractListenerWriteProcessor<T> implements Processor<T,
private void writeIfPossible() { private void writeIfPossible() {
boolean result = isWritePossible(); boolean result = isWritePossible();
if (!result && rsWriteLogger.isTraceEnabled()) { if (!result && rsWriteLogger.isTraceEnabled()) {
rsWriteLogger.trace(getLogPrefix() + "isWritePossible: false"); rsWriteLogger.trace(getLogPrefix() + "isWritePossible false");
} }
if (result) { if (result) {
onWritePossible(); onWritePossible();

17
spring-web/src/main/java/org/springframework/http/server/reactive/ServletHttpHandlerAdapter.java
View File

@@ -279,7 +279,10 @@ public class ServletHttpHandlerAdapter implements Servlet {
@Override @Override
public void onTimeout(AsyncEvent event) { public void onTimeout(AsyncEvent event) {
logger.debug(this.logPrefix + "Timeout notification"); // Should never happen since we call asyncContext.setTimeout(-1)
if (logger.isDebugEnabled()) {
logger.debug(this.logPrefix + "AsyncEvent onTimeout");
}
delegateTimeout(this.requestAsyncListener, event); delegateTimeout(this.requestAsyncListener, event);
delegateTimeout(this.responseAsyncListener, event); delegateTimeout(this.responseAsyncListener, event);
handleTimeoutOrError(event); handleTimeoutOrError(event);
@@ -288,7 +291,9 @@ public class ServletHttpHandlerAdapter implements Servlet {
@Override @Override
public void onError(AsyncEvent event) { public void onError(AsyncEvent event) {
Throwable ex = event.getThrowable(); Throwable ex = event.getThrowable();
logger.debug(this.logPrefix + "Error notification: " + (ex != null ? ex : "<no Throwable>")); if (logger.isDebugEnabled()) {
logger.debug(this.logPrefix + "AsyncEvent onError: " + (ex != null ? ex : "<no Throwable>"));
}
delegateError(this.requestAsyncListener, event); delegateError(this.requestAsyncListener, event);
delegateError(this.responseAsyncListener, event); delegateError(this.responseAsyncListener, event);
handleTimeoutOrError(event); handleTimeoutOrError(event);
@@ -378,7 +383,9 @@ public class ServletHttpHandlerAdapter implements Servlet {
@Override @Override
public void onError(Throwable ex) { public void onError(Throwable ex) {
logger.trace(this.logPrefix + "Failed to complete: " + ex.getMessage()); if (logger.isTraceEnabled()) {
logger.trace(this.logPrefix + "onError: " + ex.getMessage());
}
runIfAsyncNotComplete(this.asyncContext, this.completionFlag, () -> { runIfAsyncNotComplete(this.asyncContext, this.completionFlag, () -> {
if (this.asyncContext.getResponse().isCommitted()) { if (this.asyncContext.getResponse().isCommitted()) {
logger.trace(this.logPrefix + "Dispatch to container, to raise the error on servlet thread"); logger.trace(this.logPrefix + "Dispatch to container, to raise the error on servlet thread");
@@ -400,7 +407,9 @@ public class ServletHttpHandlerAdapter implements Servlet {
@Override @Override
public void onComplete() { public void onComplete() {
logger.trace(this.logPrefix + "Handling completed"); if (logger.isTraceEnabled()) {
logger.trace(this.logPrefix + "onComplete");
}
runIfAsyncNotComplete(this.asyncContext, this.completionFlag, this.asyncContext::complete); runIfAsyncNotComplete(this.asyncContext, this.completionFlag, this.asyncContext::complete);
} }

4
spring-web/src/main/java/org/springframework/http/server/reactive/ServletServerHttpResponse.java
View File

@@ -324,7 +324,7 @@ class ServletServerHttpResponse extends AbstractListenerServerHttpResponse {
@Override @Override
protected void flush() throws IOException { protected void flush() throws IOException {
if (rsWriteFlushLogger.isTraceEnabled()) { if (rsWriteFlushLogger.isTraceEnabled()) {
rsWriteFlushLogger.trace(getLogPrefix() + "Flush attempt"); rsWriteFlushLogger.trace(getLogPrefix() + "flushing");
} }
ServletServerHttpResponse.this.flush(); ServletServerHttpResponse.this.flush();
} }
@@ -362,7 +362,7 @@ class ServletServerHttpResponse extends AbstractListenerServerHttpResponse {
protected boolean write(DataBuffer dataBuffer) throws IOException { protected boolean write(DataBuffer dataBuffer) throws IOException {
if (ServletServerHttpResponse.this.flushOnNext) { if (ServletServerHttpResponse.this.flushOnNext) {
if (rsWriteLogger.isTraceEnabled()) { if (rsWriteLogger.isTraceEnabled()) {
rsWriteLogger.trace(getLogPrefix() + "Flush attempt"); rsWriteLogger.trace(getLogPrefix() + "flushing");
} }
flush(); flush();
} }

34
spring-web/src/main/java/org/springframework/http/server/reactive/WriteResultPublisher.java
View File

@@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2020 the original author or authors. * Copyright 2002-2021 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -69,7 +69,7 @@ class WriteResultPublisher implements Publisher<Void> {
@Override @Override
public final void subscribe(Subscriber<? super Void> subscriber) { public final void subscribe(Subscriber<? super Void> subscriber) {
if (rsWriteResultLogger.isTraceEnabled()) { if (rsWriteResultLogger.isTraceEnabled()) {
rsWriteResultLogger.trace(this.logPrefix + this.state + " subscribe: " + subscriber); rsWriteResultLogger.trace(this.logPrefix + "got subscriber " + subscriber);
} }
this.state.get().subscribe(this, subscriber); this.state.get().subscribe(this, subscriber);
} }
@@ -78,20 +78,22 @@ class WriteResultPublisher implements Publisher<Void> {
* Invoke this to delegate a completion signal to the subscriber. * Invoke this to delegate a completion signal to the subscriber.
*/ */
public void publishComplete() { public void publishComplete() {
State state = this.state.get();
if (rsWriteResultLogger.isTraceEnabled()) { if (rsWriteResultLogger.isTraceEnabled()) {
rsWriteResultLogger.trace(this.logPrefix + this.state + " publishComplete"); rsWriteResultLogger.trace(this.logPrefix + "completed [" + state + "]");
} }
this.state.get().publishComplete(this); state.publishComplete(this);
} }
/** /**
* Invoke this to delegate an error signal to the subscriber. * Invoke this to delegate an error signal to the subscriber.
*/ */
public void publishError(Throwable t) { public void publishError(Throwable t) {
State state = this.state.get();
if (rsWriteResultLogger.isTraceEnabled()) { if (rsWriteResultLogger.isTraceEnabled()) {
rsWriteResultLogger.trace(this.logPrefix + this.state + " publishError: " + t); rsWriteResultLogger.trace(this.logPrefix + "failed: " + t + " [" + state + "]");
} }
this.state.get().publishError(this, t); state.publishError(this, t);
} }
private boolean changeState(State oldState, State newState) { private boolean changeState(State oldState, State newState) {
@@ -114,20 +116,22 @@ class WriteResultPublisher implements Publisher<Void> {
@Override @Override
public final void request(long n) { public final void request(long n) {
if (rsWriteResultLogger.isTraceEnabled()) { if (rsWriteResultLogger.isTraceEnabled()) {
rsWriteResultLogger.trace(this.publisher.logPrefix + state() + " request: " + n); rsWriteResultLogger.trace(this.publisher.logPrefix +
"request " + (n != Long.MAX_VALUE ? n : "Long.MAX_VALUE"));
} }
state().request(this.publisher, n); getState().request(this.publisher, n);
} }
@Override @Override
public final void cancel() { public final void cancel() {
State state = getState();
if (rsWriteResultLogger.isTraceEnabled()) { if (rsWriteResultLogger.isTraceEnabled()) {
rsWriteResultLogger.trace(this.publisher.logPrefix + state() + " cancel"); rsWriteResultLogger.trace(this.publisher.logPrefix + "cancel [" + state + "]");
} }
state().cancel(this.publisher); state.cancel(this.publisher);
} }
private State state() { private State getState() {
return this.publisher.state.get(); return this.publisher.state.get();
} }
} }
@@ -161,11 +165,11 @@ class WriteResultPublisher implements Publisher<Void> {
publisher.changeState(SUBSCRIBING, SUBSCRIBED); publisher.changeState(SUBSCRIBING, SUBSCRIBED);
// Now safe to check "beforeSubscribed" flags, they won't change once in NO_DEMAND // Now safe to check "beforeSubscribed" flags, they won't change once in NO_DEMAND
if (publisher.completedBeforeSubscribed) { if (publisher.completedBeforeSubscribed) {
publisher.publishComplete(); publisher.state.get().publishComplete(publisher);
} }
Throwable publisherError = publisher.errorBeforeSubscribed; Throwable ex = publisher.errorBeforeSubscribed;
if (publisherError != null) { if (ex != null) {
publisher.publishError(publisherError); publisher.state.get().publishError(publisher, ex);
} }
} }
else { else {