Nemcio/SCM-Manager
1
0
Fork 0
mirror of https://github.com/scm-manager/scm-manager.git synced 2025-11-12 16:35:45 +01:00
Code Issues Packages Projects Releases Activity

Add transaction id to http request

Browse Source
This commit is contained in:
René Pfeuffer
2018-10-25 12:34:32 +02:00
parent a36768fbb3
commit bda5b41271
5 changed files with 16 additions and 11 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
scm-webapp/src/main/java/sonia/scm/api/v2/resources/ErrorDto.java
View File

@@ -2,6 +2,7 @@ package sonia.scm.api.v2.resources;
import com.fasterxml.jackson.annotation.JsonInclude; import com.fasterxml.jackson.annotation.JsonInclude;
import lombok.Getter; import lombok.Getter;
import org.slf4j.MDC;
import sonia.scm.ContextEntry; import sonia.scm.ContextEntry;
import sonia.scm.NotFoundException; import sonia.scm.NotFoundException;
@@ -29,6 +30,6 @@ public class ErrorDto {
} }
static ErrorDto from(NotFoundException notFoundException) { static ErrorDto from(NotFoundException notFoundException) {
return new ErrorDto("todo", "todo", notFoundException.getContext(), notFoundException.getMessage()); return new ErrorDto(MDC.get("transaction_id"), "todo", notFoundException.getContext(), notFoundException.getMessage());
} }
} }

13
scm-webapp/src/main/java/sonia/scm/filter/MDCFilter.java
View File

@@ -41,6 +41,8 @@ import org.apache.shiro.subject.Subject;
import org.slf4j.MDC; import org.slf4j.MDC;
import sonia.scm.SCMContext; import sonia.scm.SCMContext;
import sonia.scm.security.DefaultKeyGenerator;
import sonia.scm.security.KeyGenerator;
import sonia.scm.web.filter.HttpFilter; import sonia.scm.web.filter.HttpFilter;
//~--- JDK imports ------------------------------------------------------------ //~--- JDK imports ------------------------------------------------------------
@@ -61,27 +63,26 @@ import sonia.scm.Priority;
@WebElement(Filters.PATTERN_ALL) @WebElement(Filters.PATTERN_ALL)
public class MDCFilter extends HttpFilter public class MDCFilter extends HttpFilter
{ {
private static final DefaultKeyGenerator TRANSACTION_KEY_GENERATOR = new DefaultKeyGenerator();
/** Field description */
@VisibleForTesting @VisibleForTesting
static final String MDC_CLIENT_HOST = "client_host"; static final String MDC_CLIENT_HOST = "client_host";
/** Field description */
@VisibleForTesting @VisibleForTesting
static final String MDC_CLIENT_IP = "client_ip"; static final String MDC_CLIENT_IP = "client_ip";
/** url of the current request */
@VisibleForTesting @VisibleForTesting
static final String MDC_REQUEST_URI = "request_uri"; static final String MDC_REQUEST_URI = "request_uri";
/** request method */
@VisibleForTesting @VisibleForTesting
static final String MDC_REQUEST_METHOD = "request_method"; static final String MDC_REQUEST_METHOD = "request_method";
/** Field description */
@VisibleForTesting @VisibleForTesting
static final String MDC_USERNAME = "username"; static final String MDC_USERNAME = "username";
@VisibleForTesting
static final String MDC_TRANSACTION_ID = "transaction_id";
//~--- methods -------------------------------------------------------------- //~--- methods --------------------------------------------------------------
/** /**
@@ -105,6 +106,7 @@ public class MDCFilter extends HttpFilter
MDC.put(MDC_CLIENT_HOST, request.getRemoteHost()); MDC.put(MDC_CLIENT_HOST, request.getRemoteHost());
MDC.put(MDC_REQUEST_METHOD, request.getMethod()); MDC.put(MDC_REQUEST_METHOD, request.getMethod());
MDC.put(MDC_REQUEST_URI, request.getRequestURI()); MDC.put(MDC_REQUEST_URI, request.getRequestURI());
MDC.put(MDC_TRANSACTION_ID, TRANSACTION_KEY_GENERATOR.createKey());
try try
{ {
@@ -117,6 +119,7 @@ public class MDCFilter extends HttpFilter
MDC.remove(MDC_CLIENT_HOST); MDC.remove(MDC_CLIENT_HOST);
MDC.remove(MDC_REQUEST_METHOD); MDC.remove(MDC_REQUEST_METHOD);
MDC.remove(MDC_REQUEST_URI); MDC.remove(MDC_REQUEST_URI);
MDC.remove(MDC_TRANSACTION_ID);
} }
} }

2
scm-webapp/src/main/resources/logback.default.xml
View File

@@ -46,7 +46,7 @@
<!-- encoders are by default assigned the type <!-- encoders are by default assigned the type
ch.qos.logback.classic.encoder.PatternLayoutEncoder --> ch.qos.logback.classic.encoder.PatternLayoutEncoder -->
<encoder> <encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-10X{transaction_id}] %-5level %logger - %msg%n</pattern>
</encoder> </encoder>
</appender> </appender>

4
scm-webapp/src/main/resources/logback.release.xml
View File

@@ -61,14 +61,14 @@
<append>true</append> <append>true</append>
<encoder> <encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-10X{transaction_id}] %-5level %logger - %msg%n</pattern>
</encoder> </encoder>
</appender> </appender>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder> <encoder>
<pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger - %msg%n</pattern> <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] [%-10X{transaction_id}] %-5level %logger - %msg%n</pattern>
</encoder> </encoder>
</appender> </appender>

1
scm-webapp/src/test/java/sonia/scm/filter/MDCFilterTest.java
View File

@@ -101,6 +101,7 @@ public class MDCFilterTest extends AbstractTestBase {
assertEquals("127.0.0.1", chain.ctx.get(MDCFilter.MDC_CLIENT_IP)); assertEquals("127.0.0.1", chain.ctx.get(MDCFilter.MDC_CLIENT_IP));
assertEquals("localhost", chain.ctx.get(MDCFilter.MDC_CLIENT_HOST)); assertEquals("localhost", chain.ctx.get(MDCFilter.MDC_CLIENT_HOST));
assertEquals("GET", chain.ctx.get(MDCFilter.MDC_REQUEST_METHOD)); assertEquals("GET", chain.ctx.get(MDCFilter.MDC_REQUEST_METHOD));
assertNotNull(chain.ctx.get(MDCFilter.MDC_TRANSACTION_ID));
} }
/** /**