Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,7 @@ private void logCompletion(ServerWebExchange exchange, String correlationId, lon
.addKeyValue("http.route", routeId)
.addKeyValue("http.response.status_code", status)
.addKeyValue("correlation.id", correlationId)
.addKeyValue("correlation_id", correlationId)
.addKeyValue("event.duration_ms", TimeUnit.NANOSECONDS.toMillis(System.nanoTime() - startedAt))
.addKeyValue("reactor.signal", signal)
.log("Gateway request completed");
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
package com.digitalbank.apigateway;

import ch.qos.logback.classic.spi.ILoggingEvent;
import java.time.Instant;
import java.time.ZoneOffset;
import java.time.format.DateTimeFormatter;
import java.time.temporal.ChronoUnit;
import java.util.List;
import java.util.Locale;
import org.slf4j.event.KeyValuePair;
import org.springframework.boot.json.JsonWriter.Members;
import org.springframework.boot.logging.structured.StructuredLoggingJsonMembersCustomizer;
import org.springframework.core.env.Environment;

public final class FlatStructuredLoggingJsonMembersCustomizer
implements StructuredLoggingJsonMembersCustomizer<ILoggingEvent> {

private static final String UNKNOWN = "unknown";
private static final DateTimeFormatter TIMESTAMP_FORMATTER =
DateTimeFormatter.ofPattern("yyyy-MM-dd'T'HH:mm:ss.SSSX").withZone(ZoneOffset.UTC);
private final String service;
private final String environment;

public FlatStructuredLoggingJsonMembersCustomizer(Environment environment) {
this.service = environment.getProperty("spring.application.name", UNKNOWN);
this.environment = environment.getProperty(
"digital-bank.service.runtime-profile", environment.getProperty("spring.profiles.active", UNKNOWN));
}

@Override
public void customize(Members<ILoggingEvent> members) {
members.add("timestamp", event -> timestamp(event.getInstant()));
members.add("level", event -> event.getLevel().toString());
members.add("flat_service", event -> service);
members.add("environment", event -> environment);
members.add("flat_correlation_id", event -> contextValue(event, "correlation_id"));
members.add("flat_trace_id", event -> traceValue(event, "trace_id", "traceId", "trace.id"));
members.add("flat_span_id", event -> traceValue(event, "span_id", "spanId", "span.id"));
members.add("logger", ILoggingEvent::getLoggerName);
}

private static String timestamp(Instant instant) {
return TIMESTAMP_FORMATTER.format(instant.truncatedTo(ChronoUnit.MILLIS));
}

private static String contextValue(ILoggingEvent event, String key) {
var mdcValue = event.getMDCPropertyMap().get(key);
if (mdcValue != null && !mdcValue.isBlank()) {
return mdcValue;
}
for (KeyValuePair pair : keyValuePairs(event)) {
if (key.equals(pair.key)
&& pair.value != null
&& !pair.value.toString().isBlank()) {
return pair.value.toString();
}
}
return UNKNOWN;
}

private static String traceValue(ILoggingEvent event, String... keys) {
for (String key : keys) {
var value = event.getMDCPropertyMap().get(key);
if (value != null && !value.isBlank()) {
return value.toLowerCase(Locale.ROOT);
}
for (KeyValuePair pair : keyValuePairs(event)) {
if (key.equals(pair.key)
&& pair.value != null
&& !pair.value.toString().isBlank()) {
return pair.value.toString().toLowerCase(Locale.ROOT);
}
}
}
return UNKNOWN;
}

private static List<KeyValuePair> keyValuePairs(ILoggingEvent event) {
var pairs = event.getKeyValuePairs();
return pairs != null ? pairs : List.of();
}
}
11 changes: 11 additions & 0 deletions src/main/resources/application.yml
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,17 @@ logging:
structured:
format:
console: ecs
json:
rename:
service: ecs_service
correlation_id: ecs_correlation_id
traceId: ecs_trace_id
spanId: ecs_span_id
flat_service: service
flat_correlation_id: correlation_id
flat_trace_id: trace_id
flat_span_id: span_id
customizer: com.digitalbank.apigateway.FlatStructuredLoggingJsonMembersCustomizer

management:
tracing:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import java.time.Duration;

import org.awaitility.Awaitility;
import org.junit.jupiter.api.AfterAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
Expand Down Expand Up @@ -80,7 +81,8 @@ void downstreamServerErrorsOpenCircuitBreaker() {
client.get().uri("/gateway-test/server-error").exchange().expectStatus().is5xxServerError();

CircuitBreaker breaker = registry.circuitBreaker("gatewayDownstream-server-error-service");
assertEquals(CircuitBreaker.State.OPEN, breaker.getState());
Awaitility.await().atMost(Duration.ofSeconds(1))
.untilAsserted(() -> assertEquals(CircuitBreaker.State.OPEN, breaker.getState()));

client.get().uri("/gateway-test/server-error")
.exchange()
Expand Down
Loading