Added Logging (Logstash - ELK - Kibana) and Service Tracing with Visualization (Zipkin)

MicroServices/DataBase/pom.xml

@@ -35,6 +35,12 @@
             <groupId>org.springframework.cloud</groupId>
             <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
         </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <version>1.18.30</version>
+            <scope>compile</scope>
+        </dependency>
     </dependencies>
     <dependencyManagement>
         <dependencies>
@@ -65,6 +71,16 @@
                 <artifactId>gson</artifactId>
                 <version>2.8.9</version>
             </dependency>
+            <dependency>
+                <groupId>net.logstash.logback</groupId>
+                <artifactId>logstash-logback-encoder</artifactId>
+                <version>7.2</version>
+            </dependency>
+            <dependency>
+                <groupId>org.projectlombok</groupId>
+                <artifactId>lombok</artifactId>
+                <optional>true</optional>
+            </dependency>
         </dependencies>
 
     </dependencyManagement>

MicroServices/DataBase/src/main/java/org/example/FlightDB.java

 package org.example;
 
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
 
+
 import java.util.Date;
 import java.util.HashMap;
 import java.util.Map;
 
 @RestController
+@Slf4j
 @RequestMapping("/flights-db")
 public class FlightDB
 {
@@ -23,6 +26,7 @@ public class FlightDB
     @RequestMapping("/{flightID}")
     public static Flight getFlight(@PathVariable("flightID") String flightID)
     {
+        log.info("Query on Flight with ID : " + flightID);
         if (flightsDB.containsKey(flightID)) return flightsDB.get(flightID);
         return new Flight("",new Date(),"");
     }

MicroServices/DataBase/src/main/java/org/example/UserDB.java

 package org.example;
 
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
 import org.springframework.web.bind.annotation.RestController;
@@ -7,6 +8,7 @@ import org.springframework.web.bind.annotation.RestController;
 import java.util.HashMap;
 import java.util.Map;
 
+@Slf4j
 @RestController
 @RequestMapping("/users-db")
 public class UserDB
@@ -22,6 +24,7 @@ public class UserDB
     @RequestMapping("/{userID}")
     public static User getUser(@PathVariable("userID")String userID)
     {
+        log.info("Query on User with ID : " + userID);
         System.out.println(usersDB.get(userID));
         if (usersDB.containsKey(userID)) return usersDB.get(userID);
         return null;

MicroServices/DataBase/src/main/resources/logback-spring.xml

+<configuration>
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+            <level>INFO</level>
+        </filter>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+            <charset>utf8</charset>
+        </encoder>
+    </appender>
+    <appender name="FILE"
+              class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <file>logs/catalog.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <fileNamePattern>logs/catalog.%d{yyyy-MM-dd}.log</fileNamePattern>
+            <maxHistory>10</maxHistory>
+            <totalSizeCap>1GB</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+        </encoder>
+    </appender>
+    <appender name="STASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
+        <destination>localhost:5000</destination>
+        <encoder
+                class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
+            <providers>
+                <mdc />
+                <context />
+                <logLevel />
+                <loggerName />
+                <pattern>
+                    <pattern>
+                        {
+                        "appName": "DataBase-service"
+                        }
+                    </pattern>
+                </pattern>
+                <threadName />
+                <message />
+                <logstashMarkers />
+                <stackTrace />
+            </providers>
+        </encoder>
+    </appender>
+    <root level="INFO">
+        <appender-ref ref="CONSOLE" />
+        <appender-ref ref="FILE" />
+        <appender-ref ref="STASH" />
+    </root>
+</configuration>
\ No newline at end of file

MicroServices/DiscAndReg/pom.xml

@@ -39,6 +39,16 @@
             <type>pom</type>
             <scope>import</scope>
         </dependency>
+        <dependency>
+            <groupId>net.logstash.logback</groupId>
+            <artifactId>logstash-logback-encoder</artifactId>
+            <version>7.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>

MicroServices/ReadME.txt

@@ -37,3 +37,17 @@ Configure the Grafana.
     - Access "home"
     - Import dashboard
     - Upload dashboard.json from /docker
+
+
+## Centralize spring boot log to ELK Elasticsearch, Logstash, Kibana
+
+### Step 1
+Use docker-compose to start ELK servers.
+- In the root folder
+```sh
+docker-compose -f docker-compose-elk.yml up
+```
+
+### Step 2
+Check the kibana server.
+- Open http://localhost:5601

MicroServices/UserService/pom.xml

@@ -47,6 +47,18 @@
             <artifactId>WeatherService</artifactId>
             <version>0.0.1-SNAPSHOT</version>
             <scope>compile</scope>
+
+        </dependency>
+
+        <dependency>
+            <groupId>net.logstash.logback</groupId>
+            <artifactId>logstash-logback-encoder</artifactId>
+            <version>7.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
         </dependency>
 
     </dependencies>

MicroServices/UserService/src/main/java/org/example/UserService.java

 package org.example;
 
 
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -11,6 +12,7 @@ import org.springframework.web.client.RestTemplate;
 import java.util.ArrayList;
 import java.util.List;
 
+@Slf4j
 @RestController
 @RequestMapping("/users")
 public class UserService
@@ -25,11 +27,15 @@ public class UserService
     @RequestMapping("/{userID}")
     public List<Flight> getFlights(@PathVariable("userID") String userID)
     {
+        log.info("Query on Flights for User with ID : " + userID);
         User user = restTemplate.getForObject(UserDBURL+userID , User.class);
-        if (user == null) return new ArrayList<>();
+        if (user == null)
+        {
+            log.warn("No User With ID : " + userID);
+            return new ArrayList<>();
+        }
         System.out.println("Welcome : " + user.getName());
         List<Flight> ans = new ArrayList<>();
-       /// System.out.println("Ans size is " + user.getFlights().size());
 
         for (String flightID : user.getFlights())
         {
@@ -43,8 +49,14 @@ public class UserService
     @RequestMapping("/weather/{flightID}")
     public Weather getWeather(@PathVariable("flightID") String flightID)
     {
+        log.info("Query on Weather and Forecast for Destination of Flight : " + flightID);
         Flight flight = restTemplate.getForObject(FlightDBURL+flightID , Flight.class);
-        if (flight.getDestination().isEmpty() ) return new Weather();
+        if (flight.getDestination().isEmpty() )
+        {
+
+            log.warn("No Flight with ID : " + flightID);
+            return new Weather();
+        }
 
         String city = flight.getDestination();
         Weather weather = restTemplate.getForObject(WeatherURL+city , Weather.class);

MicroServices/UserService/src/main/resources/logback-spring.xml

+<configuration>
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+            <level>INFO</level>
+        </filter>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+            <charset>utf8</charset>
+        </encoder>
+    </appender>
+    <appender name="FILE"
+              class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <file>logs/catalog.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <fileNamePattern>logs/catalog.%d{yyyy-MM-dd}.log</fileNamePattern>
+            <maxHistory>10</maxHistory>
+            <totalSizeCap>1GB</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+        </encoder>
+    </appender>
+    <appender name="STASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
+        <destination>localhost:5000</destination>
+        <encoder
+                class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
+            <providers>
+                <mdc />
+                <context />
+                <logLevel />
+                <loggerName />
+                <pattern>
+                    <pattern>
+                        {
+                        "appName": "User-service"
+                        }
+                    </pattern>
+                </pattern>
+                <threadName />
+                <message />
+                <logstashMarkers />
+                <stackTrace />
+            </providers>
+        </encoder>
+    </appender>
+    <root level="INFO">
+        <appender-ref ref="CONSOLE" />
+        <appender-ref ref="FILE" />
+        <appender-ref ref="STASH" />
+    </root>
+</configuration>
\ No newline at end of file

MicroServices/UserServiceReplica/pom.xml

@@ -49,6 +49,16 @@
             <scope>compile</scope>
         </dependency>
 
+        <dependency>
+            <groupId>net.logstash.logback</groupId>
+            <artifactId>logstash-logback-encoder</artifactId>
+            <version>7.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
     </dependencies>
 
     <dependencyManagement>

MicroServices/UserServiceReplica/src/main/java/org/example/UserService.java

 package org.example;
 
 
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.PathVariable;
 import org.springframework.web.bind.annotation.RequestMapping;
@@ -10,6 +11,7 @@ import org.springframework.web.client.RestTemplate;
 import java.util.ArrayList;
 import java.util.List;
 
+@Slf4j
 @RestController
 @RequestMapping("/users")
 public class UserService
@@ -24,11 +26,15 @@ public class UserService
     @RequestMapping("/{userID}")
     public List<Flight> getFlights(@PathVariable("userID") String userID)
     {
+        log.info("Query on Flights for User with ID : " + userID);
         User user = restTemplate.getForObject(UserDBURL+userID , User.class);
-        if (user == null) return new ArrayList<>();
+        if (user == null)
+        {
+            log.warn("No User With ID : " + userID);
+            return new ArrayList<>();
+        }
         System.out.println("Welcome : " + user.getName());
         List<Flight> ans = new ArrayList<>();
-       /// System.out.println("Ans size is " + user.getFlights().size());
 
         for (String flightID : user.getFlights())
         {
@@ -42,8 +48,14 @@ public class UserService
     @RequestMapping("/weather/{flightID}")
     public Weather getWeather(@PathVariable("flightID") String flightID)
     {
+        log.info("Query on Weather and Forecast for Destination of Flight : " + flightID);
         Flight flight = restTemplate.getForObject(FlightDBURL+flightID , Flight.class);
-        if (flight.getDestination().isEmpty() ) return new Weather();
+        if (flight.getDestination().isEmpty() )
+        {
+
+            log.warn("No Flight with ID : " + flightID);
+            return new Weather();
+        }
 
         String city = flight.getDestination();
         Weather weather = restTemplate.getForObject(WeatherURL+city , Weather.class);

MicroServices/UserServiceReplica/src/main/resources/logback-spring.xml

+<configuration>
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+            <level>INFO</level>
+        </filter>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+            <charset>utf8</charset>
+        </encoder>
+    </appender>
+    <appender name="FILE"
+              class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <file>logs/catalog.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <fileNamePattern>logs/catalog.%d{yyyy-MM-dd}.log</fileNamePattern>
+            <maxHistory>10</maxHistory>
+            <totalSizeCap>1GB</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+        </encoder>
+    </appender>
+    <appender name="STASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
+        <destination>localhost:5000</destination>
+        <encoder
+                class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
+            <providers>
+                <mdc />
+                <context />
+                <logLevel />
+                <loggerName />
+                <pattern>
+                    <pattern>
+                        {
+                        "appName": "User-service-Replica"
+                        }
+                    </pattern>
+                </pattern>
+                <threadName />
+                <message />
+                <logstashMarkers />
+                <stackTrace />
+            </providers>
+        </encoder>
+    </appender>
+    <root level="INFO">
+        <appender-ref ref="CONSOLE" />
+        <appender-ref ref="FILE" />
+        <appender-ref ref="STASH" />
+    </root>
+</configuration>
\ No newline at end of file

MicroServices/WeatherService/pom.xml

@@ -59,6 +59,16 @@
             <artifactId>jettison</artifactId>
             <version>1.1</version>
         </dependency>
+        <dependency>
+            <groupId>net.logstash.logback</groupId>
+            <artifactId>logstash-logback-encoder</artifactId>
+            <version>7.2</version>
+        </dependency>
+        <dependency>
+            <groupId>org.projectlombok</groupId>
+            <artifactId>lombok</artifactId>
+            <optional>true</optional>
+        </dependency>
     </dependencies>
     <dependencyManagement>
         <dependencies>

MicroServices/WeatherService/src/main/java/org/example/WeatherService.java

 package org.example;
 
+import lombok.extern.slf4j.Slf4j;
 import org.codehaus.jettison.json.JSONException;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.beans.factory.annotation.Value;
@@ -10,7 +11,7 @@ import org.springframework.web.client.RestTemplate;
 
 import java.io.IOException;
 
-
+@Slf4j
 @RestController
 @RequestMapping("/weather")
 public class WeatherService
@@ -24,10 +25,12 @@ public class WeatherService
     String prefURL = "http://api.weatherapi.com/v1/current.json?key="+ myAPIKey + "&q=";
     String sufURL = "&aqi=yes";
     @RequestMapping("/{city}")
-    public Weather getWeather(@PathVariable("city") String city) throws IOException {
-        System.out.println("My Api = " + myAPIKey);
+    public Weather getWeather(@PathVariable("city") String city) throws IOException
+    {
+
         if (city.isEmpty())
         {
+            log.warn("Request With Empty City");
             System.out.println("City is Empty");
             return new Weather();
         }
@@ -38,8 +41,7 @@ public class WeatherService
 
         } catch (JSONException e)
         {
-            System.out.println("EERRRERERER");
-            //log
+            log.error("JSON Parsing Error in External API Request for City : " + city);
         }
         return weather;
     }

MicroServices/WeatherService/src/main/resources/logback-spring.xml

+<configuration>
+    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
+        <filter class="ch.qos.logback.classic.filter.ThresholdFilter">
+            <level>INFO</level>
+        </filter>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+            <charset>utf8</charset>
+        </encoder>
+    </appender>
+    <appender name="FILE"
+              class="ch.qos.logback.core.rolling.RollingFileAppender">
+        <file>logs/catalog.log</file>
+        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
+            <fileNamePattern>logs/catalog.%d{yyyy-MM-dd}.log</fileNamePattern>
+            <maxHistory>10</maxHistory>
+            <totalSizeCap>1GB</totalSizeCap>
+        </rollingPolicy>
+        <encoder>
+            <pattern>%d{HH:mm:ss.SSS} %-5level %msg%n</pattern>
+        </encoder>
+    </appender>
+    <appender name="STASH" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
+        <destination>localhost:5000</destination>
+        <encoder
+                class="net.logstash.logback.encoder.LoggingEventCompositeJsonEncoder">
+            <providers>
+                <mdc />
+                <context />
+                <logLevel />
+                <loggerName />
+                <pattern>
+                    <pattern>
+                        {
+                        "appName": "weather-service"
+                        }
+                    </pattern>
+                </pattern>
+                <threadName />
+                <message />
+                <logstashMarkers />
+                <stackTrace />
+            </providers>
+        </encoder>
+    </appender>
+    <root level="INFO">
+        <appender-ref ref="CONSOLE" />
+        <appender-ref ref="FILE" />
+        <appender-ref ref="STASH" />
+    </root>
+</configuration>
\ No newline at end of file

MicroServices/docker-compose-elk.yml

+version: "3"
+
+services:
+
+    elasticsearch:
+      image: docker.elastic.co/elasticsearch/elasticsearch:8.3.3
+      container_name: elasticsearch
+      environment:
+          - bootstrap.memory_lock=true
+          - "ES_JAVA_OPTS=-Xms512m -Xmx512m"
+          - "discovery.type=single-node"
+          - xpack.security.enabled=false
+      ports:
+          - "9200:9200"
+      volumes:
+          - elasticsearch_data:/usr/share/elasticsearch/data
+      networks:
+          - elastic
+
+    kibana:
+      image: docker.elastic.co/kibana/kibana:8.3.3
+      container_name: kibana
+      ports:
+          - "5601:5601"
+      environment:
+          ELASTICSEARCH_URL: http://elasticsearch:9200
+          ELASTICSEARCH_HOSTS: '["http://elasticsearch:9200"]'
+      depends_on:
+          - elasticsearch
+      networks:
+          - elastic
+
+    logstash:
+      image: docker.elastic.co/logstash/logstash:8.3.3
+      container_name: logstash
+      volumes:
+        - ./docker/logstash/config/logstash.yml:/usr/share/logstash/config/logstash.yml:ro
+        - ./docker/logstash/pipeline:/usr/share/logstash/pipeline:ro
+      ports:
+        - "5044:5044"
+        - "5000:5000/tcp"
+        - "5000:5000/udp"
+        - "9600:9600"
+      environment:
+        LS_JAVA_OPTS: "-Xmx256m -Xms256m"
+      networks:
+        - elastic
+      depends_on:
+        - elasticsearch
+
+    zipkin:
+      image: openzipkin/zipkin
+      container_name: zipkin
+      ports:
+        - "9411:9411"
+      networks:
+        - elastic
+networks:
+  elastic:
+    driver: bridge
+
+volumes:
+    elasticsearch_data:
+        driver: local
\ No newline at end of file

MicroServices/docker/logstash/config/logstash.yml

+http.host: "0.0.0.0"
+path.config: /usr/share/logstash/pipeline
+xpack.monitoring.elasticsearch.hosts: [ "elasticsearch:9200" ]
\ No newline at end of file

MicroServices/docker/logstash/pipeline/logstash.conf

+input {
+  tcp{
+	port => 5000
+	codec => json
+  }
+}
+
+output {
+
+  elasticsearch {
+    hosts => "elasticsearch:9200"
+	index => "springboot-%{app}"
+  }
+}
\ No newline at end of file