package org.onap.portalng.preferences;
+import org.onap.portalng.preferences.logging.LoggerProperties;
import org.onap.portalng.preferences.configuration.PreferencesConfig;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.EnableConfigurationProperties;
-@EnableConfigurationProperties(PreferencesConfig.class)
@SpringBootApplication
+@EnableConfigurationProperties({PreferencesConfig.class, LoggerProperties.class})
public class PreferencesApplication {
public static void main(String[] args) {
--- /dev/null
+/*
+ *
+ * Copyright (c) 2023. Deutsche Telekom AG
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ *
+ */
+
+package org.onap.portalng.preferences.logging;
+
+import lombok.Getter;
+
+@Getter
+public enum LogContextVariable {
+ TRACE_ID("trace_id"),
+ STATUS("status"),
+ NORTHBOUND_METHOD("northbound.method"),
+ NORTHBOUND_URL("northbound.url"),
+ EXECUTION_TIME("execution.time_ms"),
+ HTTP_STATUS("httpStatus");
+
+ private final String variableName;
+
+ LogContextVariable(String variableName) {
+ this.variableName = variableName;
+ }
+}
--- /dev/null
+package org.onap.portalng.preferences.logging;
+
+import java.util.List;
+
+import org.springframework.boot.context.properties.ConfigurationProperties;
+
+@ConfigurationProperties("logger")
+public record LoggerProperties(
+ String traceIdHeaderName,
+ Boolean enabled, List<String> excludePaths) {
+}
\ No newline at end of file
--- /dev/null
+/*
+ *
+ * Copyright (c) 2023. Deutsche Telekom AG
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ *
+ */
+
+package org.onap.portalng.preferences.logging;
+
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.slf4j.Logger;
+import org.slf4j.MDC;
+
+import java.util.Map;
+import java.util.function.BiConsumer;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class LoggingHelper {
+ public static void error(
+ Logger logger, Map<LogContextVariable, String> metadata, String message, Object... args) {
+ log(logger::error, metadata, message, args);
+ }
+
+ public static void debug(
+ Logger logger, Map<LogContextVariable, String> metadata, String message, Object... args) {
+ log(logger::debug, metadata, message, args);
+ }
+
+ public static void info(
+ Logger logger, Map<LogContextVariable, String> metadata, String message, Object... args) {
+ log(logger::info, metadata, message, args);
+ }
+
+ public static void warn(
+ Logger logger, Map<LogContextVariable, String> metadata, String message, Object... args) {
+ log(logger::warn, metadata, message, args);
+ }
+
+ public static void trace(
+ Logger logger, Map<LogContextVariable, String> metadata, String message, Object... args) {
+ log(logger::trace, metadata, message, args);
+ }
+
+ private static void log(
+ BiConsumer<String, Object[]> logMethod,
+ Map<LogContextVariable, String> metadata,
+ String message,
+ Object... args) {
+ metadata.forEach((variable, value) -> MDC.put(variable.getVariableName(), value));
+ logMethod.accept(message, args);
+ MDC.clear();
+ }
+}
--- /dev/null
+/*
+ *
+ * Copyright (c) 2023. Deutsche Telekom AG
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ *
+ */
+
+package org.onap.portalng.preferences.logging;
+
+import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+import org.springframework.stereotype.Component;
+import org.springframework.web.server.ServerWebExchange;
+import org.springframework.web.server.WebFilter;
+import org.springframework.web.server.WebFilterChain;
+import reactor.core.publisher.Mono;
+
+import java.time.Duration;
+import java.time.LocalDateTime;
+
+@Slf4j
+@Component
+@RequiredArgsConstructor
+@ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.REACTIVE)
+public class ReactiveRequestLoggingFilter implements WebFilter {
+
+ private final LoggerProperties loggerProperties;
+
+ @Override
+ public Mono<Void> filter(ServerWebExchange exchange, WebFilterChain chain) {
+ if (loggingDisabled(exchange)) {
+ return chain.filter(exchange);
+ }
+
+ var logMessageMetadata =
+ WebExchangeUtils.getRequestMetadata(exchange, loggerProperties.traceIdHeaderName());
+
+ LoggingHelper.info(log, logMessageMetadata, "RECEIVED");
+
+ var invocationStart = LocalDateTime.now();
+ return chain
+ .filter(exchange)
+ .doOnTerminate(
+ () -> {
+ logMessageMetadata.put(
+ LogContextVariable.STATUS,
+ exchange.getResponse().getStatusCode().isError()
+ ? StatusCode.ERROR.name()
+ : StatusCode.COMPLETE.name());
+ logMessageMetadata.put(
+ LogContextVariable.HTTP_STATUS,
+ String.valueOf(exchange.getResponse().getStatusCode().value()));
+ logMessageMetadata.put(
+ LogContextVariable.EXECUTION_TIME,
+ String.valueOf(
+ Duration.between(invocationStart, LocalDateTime.now()).toMillis()));
+ })
+ .doOnSuccess(res -> LoggingHelper.info(log, logMessageMetadata, "FINISHED"))
+ .doOnError(
+ ex -> LoggingHelper.warn(log, logMessageMetadata, "FAILED: {}", ex.getMessage()));
+ }
+
+ private boolean loggingDisabled(ServerWebExchange exchange) {
+ boolean loggingDisabled = loggerProperties.enabled() == null || !loggerProperties.enabled();
+
+ boolean urlShouldBeSkipped =
+ WebExchangeUtils.matchUrlsPatternsToPath(loggerProperties.excludePaths(), exchange.getRequest().getPath().value());
+
+ return loggingDisabled || urlShouldBeSkipped;
+ }
+}
--- /dev/null
+/*
+ *
+ * Copyright (c) 2023. Deutsche Telekom AG
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ *
+ */
+
+package org.onap.portalng.preferences.logging;
+
+public enum StatusCode {
+ REQUEST,
+ COMPLETE,
+ ERROR
+}
--- /dev/null
+/*
+ *
+ * Copyright (c) 2023. Deutsche Telekom AG
+ *
+ * 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.
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ *
+ *
+ */
+
+package org.onap.portalng.preferences.logging;
+
+import lombok.AccessLevel;
+import lombok.NoArgsConstructor;
+import org.springframework.util.AntPathMatcher;
+import org.springframework.util.PathMatcher;
+import org.springframework.web.server.ServerWebExchange;
+
+import java.util.EnumMap;
+import java.util.List;
+import java.util.Map;
+
+@NoArgsConstructor(access = AccessLevel.PRIVATE)
+public class WebExchangeUtils {
+ private static final String DEFAULT_TRACE_ID = "REQUEST_ID_IS_NOT_SET";
+ private static final String DEFAULT_REQUEST_URL = "REQUEST_URL_IS_ABSENT";
+ private static final String DEFAULT_REQUEST_METHOD = "HTTP_METHOD_IS_ABSENT";
+
+ private static final PathMatcher pathMatcher = new AntPathMatcher();
+
+ public static String getRequestId(ServerWebExchange webExchange, String traceIdHeaderName) {
+ if (webExchange == null || traceIdHeaderName == null) {
+ return DEFAULT_TRACE_ID;
+ }
+
+ var requestIdHeaders = webExchange.getRequest().getHeaders().get(traceIdHeaderName);
+ if (requestIdHeaders != null) {
+ return requestIdHeaders.stream().findAny().orElse(DEFAULT_TRACE_ID);
+ } else {
+ return DEFAULT_TRACE_ID;
+ }
+ }
+
+ public static String getRequestUrl(ServerWebExchange webExchange) {
+ if (webExchange == null) {
+ return DEFAULT_REQUEST_URL;
+ }
+ return webExchange.getRequest().getURI().toString();
+ }
+
+ public static String getRequestHttpMethod(ServerWebExchange webExchange) {
+ if (webExchange == null) {
+ return DEFAULT_REQUEST_METHOD;
+ }
+ return webExchange.getRequest().getMethod().name();
+ }
+
+ public static boolean matchUrlPatternToPath(String pattern, String path) {
+ return pathMatcher.match(pattern, path);
+ }
+
+ public static boolean matchUrlsPatternsToPath(List<String> patterns, String path) {
+ return patterns != null
+ && patterns.stream().anyMatch(pathPattern -> matchUrlPatternToPath(pathPattern, path));
+ }
+
+ public static Map<LogContextVariable, String> getRequestMetadata(
+ ServerWebExchange exchange, String traceIdHeaderName) {
+ var traceId = WebExchangeUtils.getRequestId(exchange, traceIdHeaderName);
+ var requestMethod = WebExchangeUtils.getRequestHttpMethod(exchange);
+ var requestUrl = WebExchangeUtils.getRequestUrl(exchange);
+
+ var logMessageMetadata = new EnumMap<LogContextVariable, String>(LogContextVariable.class);
+ logMessageMetadata.put(LogContextVariable.TRACE_ID, traceId);
+ logMessageMetadata.put(LogContextVariable.STATUS, StatusCode.REQUEST.name());
+ logMessageMetadata.put(LogContextVariable.NORTHBOUND_METHOD, requestMethod);
+ logMessageMetadata.put(LogContextVariable.NORTHBOUND_URL, requestUrl);
+
+ return logMessageMetadata;
+ }
+}
probability: 1.0 # sample every request
zipkin:
tracing:
- endpoint: http://${COLLECTOR_HOST}:${COLLECTOR_PORT}/api/v2/spans
\ No newline at end of file
+ endpoint: http://${COLLECTOR_HOST}:${COLLECTOR_PORT}/api/v2/spans
+
+logger:
+ traceIdHeaderName: "X-Request-Id"
+ enabled: true
+ excludePaths:
+ - "/actuator/**"
\ No newline at end of file
enabled: true
java:
enabled: true
+
+logger:
+ traceIdHeaderName: "X-Request-Id"
+ enabled: true
+ excludePaths:
+ - "/actuator/**"
\ No newline at end of file
Code Review / portal-ng / preferences.git / commitdiff