-
-
Notifications
You must be signed in to change notification settings - Fork 87
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[plugin-rest-api] Add extended logging for HTTP requests and responses
- Loading branch information
Showing
9 changed files
with
457 additions
and
18 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
131 changes: 131 additions & 0 deletions
131
vividus-plugin-rest-api/src/main/java/org/vividus/http/ExtendedHttpLoggingInterceptor.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| /* | ||
| * Copyright 2019-2023 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.vividus.http; | ||
|
|
||
| import static org.apache.hc.core5.http.ContentType.APPLICATION_JSON; | ||
| import static org.apache.hc.core5.http.ContentType.APPLICATION_XML; | ||
|
|
||
| import java.io.IOException; | ||
| import java.nio.charset.StandardCharsets; | ||
| import java.util.Set; | ||
| import java.util.stream.Collectors; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import org.apache.hc.core5.http.ContentType; | ||
| import org.apache.hc.core5.http.EntityDetails; | ||
| import org.apache.hc.core5.http.Header; | ||
| import org.apache.hc.core5.http.HttpEntity; | ||
| import org.apache.hc.core5.http.HttpEntityContainer; | ||
| import org.apache.hc.core5.http.HttpRequest; | ||
| import org.apache.hc.core5.http.HttpRequestInterceptor; | ||
| import org.apache.hc.core5.http.ProtocolVersion; | ||
| import org.apache.hc.core5.http.io.entity.StringEntity; | ||
| import org.apache.hc.core5.http.protocol.HttpContext; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.slf4j.spi.LoggingEventBuilder; | ||
| import org.vividus.http.client.HttpResponse; | ||
| import org.vividus.http.handler.HttpResponseHandler; | ||
|
|
||
| public class ExtendedHttpLoggingInterceptor implements HttpRequestInterceptor, HttpResponseHandler | ||
| { | ||
| private static final String NEW_LINE = System.lineSeparator(); | ||
| private static final String HEADERS_FORMAT = String.format("%nHeaders:%n{}"); | ||
| private static final String BODY_FORMAT = String.format("%nBody:%n{}"); | ||
|
|
||
| private static final Set<String> LOGGED_CONTENT_TYPES = Set.of(APPLICATION_JSON.getMimeType(), | ||
| APPLICATION_XML.getMimeType()); | ||
|
|
||
| private final Logger logger; | ||
|
|
||
| private final boolean extendedLogging; | ||
|
|
||
| public ExtendedHttpLoggingInterceptor(Class<?> loggerType, boolean extendedLogging) | ||
| { | ||
| this.logger = LoggerFactory.getLogger(loggerType); | ||
| this.extendedLogging = extendedLogging; | ||
| } | ||
|
|
||
| @Override | ||
| public void process(HttpRequest request, EntityDetails entityDetails, HttpContext context) throws IOException | ||
| { | ||
| String argBrackets = " {}"; | ||
| LoggingEventBuilder loggingEventBuilder = logger.atInfo(); | ||
| StringBuilder loggerFormat = new StringBuilder("Request:"); | ||
|
|
||
| ProtocolVersion protocolVersion = request.getVersion(); | ||
| if (protocolVersion != null) | ||
| { | ||
| loggingEventBuilder = loggingEventBuilder.addArgument(protocolVersion); | ||
| loggerFormat.append(argBrackets); | ||
| } | ||
| loggingEventBuilder = loggingEventBuilder.addArgument(request); | ||
| loggerFormat.append(argBrackets); | ||
|
|
||
| if (extendedLogging) | ||
| { | ||
| String headersAsString = Stream.of(request.getHeaders()).map(Object::toString) | ||
| .collect(Collectors.joining(NEW_LINE)); | ||
| loggingEventBuilder = loggingEventBuilder.addArgument(headersAsString); | ||
| loggerFormat.append(HEADERS_FORMAT); | ||
|
|
||
| if (request instanceof HttpEntityContainer httpEntityContainer) | ||
| { | ||
| HttpEntity entity = httpEntityContainer.getEntity(); | ||
| if (entity instanceof StringEntity stringEntity) | ||
| { | ||
| String textBody = new String(stringEntity.getContent().readAllBytes(), StandardCharsets.UTF_8); | ||
| loggingEventBuilder = loggingEventBuilder.addArgument(textBody); | ||
| loggerFormat.append(BODY_FORMAT); | ||
| } | ||
| else if (entity != null) | ||
| { | ||
| int bodySizeInBytes = entity.getContent().available(); | ||
| loggingEventBuilder = loggingEventBuilder.addArgument(bodySizeInBytes); | ||
| loggerFormat.append(NEW_LINE).append("Body: not text data. Size {} bytes."); | ||
| } | ||
| } | ||
| } | ||
| loggingEventBuilder.log(loggerFormat.toString()); | ||
| } | ||
|
|
||
| @Override | ||
| public void handle(HttpResponse httpResponse) | ||
| { | ||
| LoggingEventBuilder loggingEventBuilder = logger.atInfo().addArgument(httpResponse.getStatusCode()) | ||
| .addArgument(httpResponse.getFrom()); | ||
| StringBuilder loggerFormat = new StringBuilder("Response: status code {}, {}"); | ||
|
|
||
| if (extendedLogging) | ||
| { | ||
| Header[] headers = httpResponse.getResponseHeaders(); | ||
| String headersAsString = Stream.of(headers).map(Object::toString).collect(Collectors.joining(NEW_LINE)); | ||
| loggingEventBuilder = loggingEventBuilder.addArgument(headersAsString); | ||
| loggerFormat.append(HEADERS_FORMAT); | ||
|
|
||
| String mimeType = MimeTypeUtils.getMimeTypeFromHeaders(headers) | ||
| .orElseGet(ContentType.DEFAULT_TEXT::getMimeType); | ||
| if (httpResponse.getResponseBody() != null | ||
| && mimeType.startsWith("text/") || LOGGED_CONTENT_TYPES.contains(mimeType)) | ||
| { | ||
| loggingEventBuilder = loggingEventBuilder.addArgument(httpResponse.getResponseBodyAsString()); | ||
| loggerFormat.append(BODY_FORMAT); | ||
| } | ||
| } | ||
| loggingEventBuilder.log(loggerFormat.toString()); | ||
| } | ||
| } |
44 changes: 44 additions & 0 deletions
44
vividus-plugin-rest-api/src/main/java/org/vividus/http/MimeTypeUtils.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,44 @@ | ||
| /* | ||
| * Copyright 2019-2023 the original author or authors. | ||
| * | ||
| * Licensed under the Apache License, Version 2.0 (the "License"); | ||
| * you may not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * https://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, software | ||
| * distributed under the License is distributed on an "AS IS" BASIS, | ||
| * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| * See the License for the specific language governing permissions and | ||
| * limitations under the License. | ||
| */ | ||
|
|
||
| package org.vividus.http; | ||
|
|
||
| import java.util.Optional; | ||
| import java.util.stream.Stream; | ||
|
|
||
| import org.apache.commons.lang3.StringUtils; | ||
| import org.apache.hc.core5.http.Header; | ||
| import org.apache.hc.core5.http.HeaderElement; | ||
| import org.apache.hc.core5.http.HttpHeaders; | ||
| import org.apache.hc.core5.http.message.MessageSupport; | ||
|
|
||
| public final class MimeTypeUtils | ||
| { | ||
| private MimeTypeUtils() | ||
| { | ||
| } | ||
|
|
||
| public static Optional<String> getMimeTypeFromHeaders(Header... headers) | ||
| { | ||
| return Stream.of(headers) | ||
| .filter(h -> HttpHeaders.CONTENT_TYPE.equalsIgnoreCase(h.getName()) | ||
| && StringUtils.isNotBlank(h.getValue())) | ||
| .findFirst() | ||
| .map(MessageSupport::parse) | ||
| .map(elements -> elements[0]) | ||
| .map(HeaderElement::getName); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
9 changes: 9 additions & 0 deletions
9
vividus-plugin-rest-api/src/main/resources/log4j2-vividus-plugin-rest-api.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Configuration> | ||
| <Loggers> | ||
| <Logger name="org.vividus.http.HttpRequestExecutor" level="INFO" additivity="false"> | ||
| <AppenderRef ref="console" /> | ||
| <AppenderRef ref="file" /> | ||
| </Logger> | ||
| </Loggers> | ||
| </Configuration> |
1 change: 1 addition & 0 deletions
1
vividus-plugin-rest-api/src/main/resources/properties/defaults/default.properties
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,3 +1,4 @@ | ||
| # Default API endpoint | ||
| rest-api.http.endpoint= | ||
| rest-api.http.cookie-store-level=global | ||
| rest-api.http.extended-logging=false |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.