feat: Add support for custom COAP requests logging #99
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| /* | ||
| * Copyright (C) 2022-2024 java-coap contributors (https://github.com/open-coap/java-coap) | ||
| * SPDX-License-Identifier: Apache-2.0 | ||
| * 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 | ||
| * | ||
| * http://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 com.mbed.coap.server; | ||
|
|
||
| import com.mbed.coap.packet.CoapRequest; | ||
| import com.mbed.coap.packet.CoapResponse; | ||
| import com.mbed.coap.utils.Filter; | ||
| import com.mbed.coap.utils.Service; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.slf4j.MDC; | ||
| import org.slf4j.event.Level; | ||
| import org.slf4j.spi.LoggingEventBuilder; | ||
|
|
||
| import java.util.HashMap; | ||
| import java.util.Map; | ||
| import java.util.concurrent.CompletableFuture; | ||
| import java.util.function.BiFunction; | ||
| import java.util.function.Function; | ||
|
|
||
| public class CoapRequestLogger implements Filter.SimpleFilter<CoapRequest, CoapResponse> { | ||
| private final LoggingEventBuilder loggingEventBuilder; | ||
| private final BiFunction<CoapRequest, CoapResponse, String> formatter; | ||
| private final Map<String, Function<CoapRequest, String>> mdcUpdaters; | ||
|
|
||
| CoapRequestLogger(Logger logger, Level level, BiFunction<CoapRequest, CoapResponse, String> formatter, Map<String, Function<CoapRequest, String>> mdcUpdaters) { | ||
| this.loggingEventBuilder = logger.atLevel(level); | ||
| this.formatter = formatter; | ||
| this.mdcUpdaters = mdcUpdaters; | ||
| } | ||
|
|
||
| @Override | ||
| public CompletableFuture<CoapResponse> apply(CoapRequest req, Service<CoapRequest, CoapResponse> service) { | ||
| mdcUpdaters.forEach((key, updater) -> MDC.put(key, updater.apply(req))); | ||
| return service.apply(req).thenApply((resp) -> { | ||
| loggingEventBuilder.log(() -> formatter.apply(req, resp)); | ||
| mdcUpdaters.forEach((key, ___) -> MDC.remove(key)); | ||
| return resp; | ||
| }); | ||
| } | ||
|
|
||
| public static CoapRequestLoggerBuilder builder() { | ||
| return new CoapRequestLoggerBuilder(); | ||
| } | ||
|
|
||
| public static class CoapRequestLoggerBuilder { | ||
| private Logger logger = LoggerFactory.getLogger(CoapRequestLogger.class); | ||
| private Level level = Level.INFO; | ||
| private BiFunction<CoapRequest, CoapResponse, String> formatter = (req, resp) -> req.toString() + " -> " + resp.toString(); | ||
| private final Map<String, Function<CoapRequest, String>> mdcUpdaters = new HashMap<>(); | ||
|
|
||
| public CoapRequestLoggerBuilder logger(Logger logger) { | ||
| this.logger = logger; | ||
| return this; | ||
| } | ||
|
|
||
| public CoapRequestLoggerBuilder level(Level level) { | ||
| this.level = level; | ||
| return this; | ||
| } | ||
|
|
||
| public CoapRequestLoggerBuilder formatter(BiFunction<CoapRequest, CoapResponse, String> formatter) { | ||
| this.formatter = formatter; | ||
| return this; | ||
| } | ||
|
|
||
| public CoapRequestLoggerBuilder mdc(String key, Function<CoapRequest, String> updater) { | ||
| mdcUpdaters.put(key, updater); | ||
| return this; | ||
| } | ||
|
|
||
| public CoapRequestLogger build() { | ||
| return new CoapRequestLogger(logger, level, formatter, mdcUpdaters); | ||
| } | ||
| } | ||
| } |
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
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
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.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could we name it somehow different, 'request' might be misleading depends on client or server. How about
inboundFilterorinboundPreFilteras it happens quite early in a filter pipeline.There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Isn't it enough to call it
inboundRequestFilterlike it is now or e.g.serverRequestFilter? There isCoapRequestConverterin the beginning of theinboundServicefilter chain which always makes CoapRequests out of the incoming packets meaning that only requests can come into this filter. Calling it justinboundPreFiltermakes a feeling that it accepts raw coap packets.