sleuth -> micrometer tracing + zipkin (#9)

migrating to(from sleuth) micrometer tracing with zipkin
gtiwari333 · Dec 25, 2023 · b829eab · b829eab
1 parent 0865627
commit b829eab
Show file tree

Hide file tree

Showing 23 changed files with 231 additions and 78 deletions.
diff --git a/README.md b/README.md
@@ -11,7 +11,7 @@
 
 MicroService:
 
-[//]: # (- Spring Micrometer based tracing)
+[//]: # (- Spring micrometer based tracing with zipkin)
 - Exposing and implementing Open Feign clients
 - Spring Cloud Contract (WIP)
 
@@ -62,6 +62,7 @@ Misc:
 - Approval/flagging api - message based
 - Nested comment
 - Cache implemented
+- Zipkin tracing 
 - Websocket implemented to show article/comment review status/notifications..
 
 Future: do more stuff
@@ -70,7 +71,6 @@ Future: do more stuff
 - Docker-compose deploy/kubernetes 
 - Visitors log - IP, browser, etc
 - Centralized error reporting
-- Visual Tracing   
 - Geo-Spatial query for visitors
 - Grafana Dashboard, @Timed and more ...
 - logback LevelChangePropagator integration

diff --git a/config/docker-compose.yml b/config/docker-compose.yml
@@ -31,6 +31,13 @@ services:
             - 8025:8025  # use this to access from browser
         networks:
             - seedappnet
+    zipkin:
+        image: 'openzipkin/zipkin'
+        container_name: zipkin
+        ports:
+            - 9411:9411
+        networks:
+            - seedappnet
 volumes:
     esdata1:
         driver: local

diff --git a/content-checker/content-checker-service/pom.xml b/content-checker/content-checker-service/pom.xml
@@ -25,6 +25,19 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-web</artifactId>
         </dependency>
+        <!-- tracing -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-tracing-bridge-brave</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.zipkin.reporter2</groupId>
+            <artifactId>zipkin-reporter-brave</artifactId>
+        </dependency>
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-artemis</artifactId>

diff --git a/content-checker/content-checker-service/src/main/resources/application.yml b/content-checker/content-checker-service/src/main/resources/application.yml
@@ -12,3 +12,19 @@ server:
 
 jms:
     content-checkerrequest-queue: jms-content-checker-requestqueue
+logging:
+    level:
+        web: INFO
+        ROOT: WARN
+        gt: DEBUG
+
+management:
+    tracing:
+        sampling:
+            probability: 1.0
+    zipkin:
+        tracing:
+            endpoint: http://localhost:9411/api/v2/spans
+    health:
+        jms:
+            enabled: true
diff --git a/email/email-service/pom.xml b/email/email-service/pom.xml
@@ -39,6 +39,19 @@
             <artifactId>spring-boot-starter-mail</artifactId>
         </dependency>
 
+        <!-- tracing -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-tracing-bridge-brave</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.zipkin.reporter2</groupId>
+            <artifactId>zipkin-reporter-brave</artifactId>
+        </dependency>
         <!-- processors/code generators -->
         <dependency>
             <groupId>org.projectlombok</groupId>

diff --git a/email/email-service/src/main/resources/application.yml b/email/email-service/src/main/resources/application.yml
@@ -15,7 +15,18 @@ spring:
 server:
     port: 8085
 
-logging.level:
-    org.springframework.web: WARN
-    ROOT: WARN
-    gt: WARN
+logging:
+    level:
+        org.springframework.web: INFO
+        ROOT: WARN
+        gt: DEBUG
+
+management:
+    tracing:
+        sampling:
+            probability: 1.0
+    zipkin:
+        tracing:
+            endpoint: http://localhost:9411/api/v2/spans
+
+
diff --git a/main-app/main-webapp/pom.xml b/main-app/main-webapp/pom.xml
@@ -76,10 +76,24 @@
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-openfeign</artifactId>
         </dependency>
-        <!--        <dependency>-->
-        <!--            <groupId>org.springframework.cloud</groupId>-->
-        <!--            <artifactId>spring-cloud-starter-sleuth</artifactId>-->
-        <!--        </dependency>-->
+        <!-- tracing -->
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-actuator</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-tracing-bridge-brave</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.zipkin.reporter2</groupId>
+            <artifactId>zipkin-reporter-brave</artifactId>
+        </dependency>
+        <dependency>
+            <groupId>io.github.openfeign</groupId>
+            <artifactId>feign-micrometer</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-artemis</artifactId>
@@ -239,6 +253,10 @@
             <groupId>com.github.gavlyukovskiy</groupId>
             <artifactId>datasource-proxy-spring-boot-starter</artifactId>
         </dependency>
+        <dependency>
+            <groupId>net.ttddyy.observation</groupId>
+            <artifactId>datasource-micrometer-spring-boot</artifactId>
+        </dependency>
 
         <!-- spock deps -->
         <dependency>

diff --git a/main-app/main-webapp/src/main/java/gt/app/MainApplication.java b/main-app/main-webapp/src/main/java/gt/app/MainApplication.java
@@ -1,11 +1,13 @@
 package gt.app;
 
+import brave.sampler.Sampler;
 import gt.app.config.AppProperties;
 import lombok.extern.slf4j.Slf4j;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.boot.context.properties.EnableConfigurationProperties;
 import org.springframework.cache.annotation.EnableCaching;
+import org.springframework.context.annotation.Bean;
 import org.springframework.core.env.Environment;
 import org.springframework.scheduling.annotation.EnableScheduling;
 
@@ -38,5 +40,9 @@ public static void main(String[] args) throws UnknownHostException {
             Arrays.toString(env.getActiveProfiles())
         );
     }
-
+    //Force sample
+    @Bean
+    public Sampler defaultSampler() {
+        return Sampler.ALWAYS_SAMPLE;
+    }
 }
diff --git a/main-app/main-webapp/src/main/java/gt/app/config/AppHibernatePropertiesCustomizer.java b/main-app/main-webapp/src/main/java/gt/app/config/AppHibernatePropertiesCustomizer.java
diff --git a/...fig/logging/HibernateStatInterceptor.java → ...ng/HibernateStatementStatInterceptor.java b/...fig/logging/HibernateStatInterceptor.java → ...ng/HibernateStatementStatInterceptor.java
@@ -1,13 +1,13 @@
 package gt.app.config.logging;
 
 import lombok.extern.slf4j.Slf4j;
-import org.hibernate.Interceptor;
+import org.hibernate.resource.jdbc.spi.StatementInspector;
 
 import java.io.Serial;
 import java.io.Serializable;
 
 @Slf4j
-public class HibernateStatInterceptor implements Interceptor, Serializable {
+public class HibernateStatementStatInterceptor implements StatementInspector, Serializable {
 
     @Serial
     private static final long serialVersionUID = -7875557911815131906L;
@@ -25,13 +25,13 @@ public void clearCounter() {
         queryCount.remove();
     }
 
-//    @Override
-//    public String onPrepareStatement(String sql) {
-//        Long count = queryCount.get();
-//        if (count != null) {
-//            queryCount.set(count + 1);
-//        }
-//
-//        return super.onPrepareStatement(sql);
-//    }
+    @Override
+    public String inspect(String sql) {
+        Long count = queryCount.get();
+        if (count != null) {
+            queryCount.set(count + 1);
+        }
+
+        return null;
+    }
 }
diff --git a/main-app/main-webapp/src/main/java/gt/app/config/logging/WebRequestInterceptor.java b/main-app/main-webapp/src/main/java/gt/app/config/logging/WebRequestInterceptor.java
@@ -11,9 +11,9 @@ public class WebRequestInterceptor implements AsyncHandlerInterceptor {
 
     private final ThreadLocal<Long> exeTimeThreadLocal = new ThreadLocal<>();
 
-    private final HibernateStatInterceptor statisticsInterceptor;
+    private final HibernateStatementStatInterceptor statisticsInterceptor;
 
-    public WebRequestInterceptor(HibernateStatInterceptor statisticsInterceptor) {
+    public WebRequestInterceptor(HibernateStatementStatInterceptor statisticsInterceptor) {
         this.statisticsInterceptor = statisticsInterceptor;
     }
 

diff --git a/main-app/main-webapp/src/main/java/gt/app/config/metrics/RequestStatisticsConfiguration.java b/main-app/main-webapp/src/main/java/gt/app/config/metrics/RequestStatisticsConfiguration.java
@@ -1,7 +1,10 @@
 package gt.app.config.metrics;
 
-import gt.app.config.logging.HibernateStatInterceptor;
+import gt.app.config.logging.HibernateStatementStatInterceptor;
 import gt.app.config.logging.WebRequestInterceptor;
+import lombok.extern.slf4j.Slf4j;
+import org.hibernate.cfg.AvailableSettings;
+import org.springframework.boot.autoconfigure.orm.jpa.HibernatePropertiesCustomizer;
 import org.springframework.context.annotation.Bean;
 import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Profile;
@@ -10,18 +13,24 @@
 
 @Configuration
 @Profile("!test")
+@Slf4j
 class RequestStatisticsConfiguration implements WebMvcConfigurer {
 
     @Bean
-    public HibernateStatInterceptor hibernateInterceptor() {
-        return new HibernateStatInterceptor();
+    public HibernateStatementStatInterceptor hibernateInterceptor() {
+        return new HibernateStatementStatInterceptor();
     }
 
-    //    @Bean this is not working
+    @Bean
     public WebRequestInterceptor requestStatisticsInterceptor() {
         return new WebRequestInterceptor(hibernateInterceptor());
     }
 
+    @Bean
+    public HibernatePropertiesCustomizer hibernateCustomizer(HibernateStatementStatInterceptor statInterceptor) {
+        return (properties) -> properties.put(AvailableSettings.STATEMENT_INSPECTOR, statInterceptor);
+    }
+
     @Override
     public void addInterceptors(InterceptorRegistry registry) {
         registry.addInterceptor(requestStatisticsInterceptor()).addPathPatterns("/", "/article/**");

diff --git a/main-app/main-webapp/src/main/java/gt/app/modules/review/CommentReviewResponseService.java b/main-app/main-webapp/src/main/java/gt/app/modules/review/CommentReviewResponseService.java
@@ -26,9 +26,11 @@ void handle(Response resp) {
             default -> throw new UnsupportedOperationException();
         }
 
-        websocketHandler.sendToUser(c.getLastModifiedByUser().getUsername(), "Your comment " + c.getContent().substring(0, 20) + " has been " + (resp.getContentCheckOutcome() == PASSED ? "approved." : "queued for manual review."));
+        int maxLengthToTrim = Math.min(c.getContent().length(), 20);
+
+        websocketHandler.sendToUser(c.getLastModifiedByUser().getUsername(), "Your comment " + c.getContent().substring(0, maxLengthToTrim) + " has been " + (resp.getContentCheckOutcome() == PASSED ? "approved." : "queued for manual review."));
         if (resp.getContentCheckOutcome() != PASSED) {
-            websocketHandler.sendToUser("system", "A new comment " + c.getContent().substring(0, 20) + " has is queued for system admin review.");
+            websocketHandler.sendToUser("system", "A new comment " + c.getContent().substring(0, maxLengthToTrim) + " has is queued for system admin review.");
         }
 
         commentRepository.save(c);

diff --git a/.../main-webapp/src/main/java/gt/app/modules/review/ContentCheckResponseListenerService.java b/.../main-webapp/src/main/java/gt/app/modules/review/ContentCheckResponseListenerService.java
@@ -16,7 +16,7 @@ public class ContentCheckResponseListenerService {
 
     @JmsListener(destination = "${app-properties.jms.content-checkercallback-response-queue}")
     void handleContentCheckResponse(Response resp) {
-
+        log.info("Received review response for entity id {}, entity type {}, outcome {}", resp.getEntityId(), resp.getRequestType(), resp.getContentCheckOutcome());
         switch (resp.getRequestType()) {
             case COMMENT -> commentReviewResponseService.handle(resp);
             case ARTICLE -> articleReviewResponseService.handle(resp);

diff --git a/main-app/main-webapp/src/main/java/gt/app/modules/review/JmsContentCheckService.java b/main-app/main-webapp/src/main/java/gt/app/modules/review/JmsContentCheckService.java
@@ -4,6 +4,7 @@
 import gt.app.domain.Article;
 import gt.app.domain.Comment;
 import lombok.RequiredArgsConstructor;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.context.annotation.Profile;
 import org.springframework.jms.core.JmsTemplate;
 import org.springframework.scheduling.annotation.Async;
@@ -16,21 +17,24 @@
 @RequiredArgsConstructor
 @Service
 @Profile("!test")
+@Slf4j
 public class JmsContentCheckService implements ContentCheckService {
 
     private final JmsTemplate jmsTemplate;
     private final AppProperties appProperties;
 
     @Override
-    @Async
+    @Async //TODO: tracing is not working with async yet !
     public void sendForAutoContentReview(Article a) {
+        log.info("Sending article {} for review", a.getId());
         var req = withArticle(a.getContent(), appProperties.getJms().getContentCheckerCallBackResponseQueue(), Long.toString(a.getId()), ARTICLE);
         jmsTemplate.convertAndSend(appProperties.getJms().getContentCheckerRequestQueue(), req);
     }
 
     @Override
     @Async
     public void sendForAutoContentReview(Comment c) {
+        log.info("Sending comment {} for review", c.getId());
         var req = withArticle(c.getContent(), appProperties.getJms().getContentCheckerCallBackResponseQueue(), Long.toString(c.getId()), COMMENT);
         jmsTemplate.convertAndSend(appProperties.getJms().getContentCheckerRequestQueue(), req);
     }

diff --git a/main-app/main-webapp/src/main/resources/application-dev.yml b/main-app/main-webapp/src/main/resources/application-dev.yml
@@ -1,6 +1,6 @@
 spring:
     thymeleaf:
-        cache: false # set to false, this if you are working on UI
+        cache: true # set to false, this if you are working on UI
         prefix: file:main-app/main-webapp/src/main/resources/templates/  #directly serve from src folder instead of target
     web:
         resources:
@@ -10,10 +10,10 @@ spring:
                 - classpath:/resources/
                 - classpath:/static/
                 - classpath:/public/
-#            cache:
-#                period: 500000
-#            chain:
-#                cache: true
+            cache:
+                period: 500000
+            chain:
+                cache: true
     mvc:
         static-path-pattern: /static/**