Added some extra metrics checks, and a stored procedure to the database.

Author: Chris Parsons

README.MD

@@ -32,24 +32,27 @@ set. This can be executed with `.\gradlew flywayMigrate` and will update the dat
 ## Docker ##
 The docker-compose file contains docker containers for MySQL, Prometheus, AlertManager and Grafana.
 
-### MySQL ###
+## MySQL ##
 MySQL is booted up in a container as the backend database for the application. Flyway should be used to populate the data, then
 the application can fetch the data from the database. Flyway connects using a JDBC connection, but the Spring Boot application
 uses R2DBC to connect for asynchronous purposes. The mydb database can then be connected to locally using the 3306 port.
 
-### Prometheus ###
+## Prometheus ##
 Prometheus collects metrics from the service. It uses the service at `user-api-service:9092` and the yml [here](docker/prometheus/prometheus.yml).
 
+![prometheus.png](src/main/resources/prometheus.png)
 
-### Alert Manager ###
+## Alert Manager ##
 Alert Manager isn't set up to do anything, but would normally evaluate Prometheus rules with any alerts being routed to the receiver
 as set in the [alertmanager](docker/alertmanager/alertmanager.yml) yml file.
 
-### Grafana ###
+## Grafana ##
 Grafana uses a default dashboard to display data for the springboot service. We can set up Prometheus as a data source, then import
 the dashboard from Grafana from https://grafana.com/grafana/dashboards/11378. This then shows the metrics churned out from the 
 service in real time.
 
+![grafana.png](src/main/resources/grafana.png)
+
 ## Helm ##
 Helm files can be created using `helm create userdataapi`. This includes templates and helpers as well as the default value
 file. Deployment strategies (ie for rolling upgrades) can be set in the [deployment](helm/userdataapi/templates/deployment.yaml) yaml.

docker/docker-compose.yml

@@ -2,22 +2,22 @@ services:
 
   # Applications
 
-  user-api-service:
-    depends_on:
-      usermysql:
-        condition: service_healthy
-      prometheus:
-        condition: service_started
-      grafana:
-        condition: service_started
-      alertmanager:
-        condition: service_started
-    image: "user-data-api-docker-image"
-    container_name: "user-data-api-docker-image"
-    ports:
-      - "9092:9092"
-    environment:
-      - SPRING_R2DBC_URL=r2dbc:mysql://usermysql:3306/mydb
+#  user-api-service:
+#    depends_on:
+#      usermysql:
+#        condition: service_healthy
+#      prometheus:
+#        condition: service_started
+#      grafana:
+#        condition: service_started
+#      alertmanager:
+#        condition: service_started
+#    image: "user-data-api-docker-image"
+#    container_name: "user-data-api-docker-image"
+#    ports:
+#      - "9092:9092"
+#    environment:
+#      - SPRING_R2DBC_URL=r2dbc:mysql://usermysql:3306/mydb
 
   # Backing Services
 

docker/prometheus/prometheus.yml

@@ -8,7 +8,7 @@ rule_files:
 scrape_configs:
   - job_name: 'user-service'
     scrape_interval: 2s
-    metrics_path: '/actuator/prometheus'
+    metrics_path: '/metrics'
     static_configs:
       - targets: [ 'user-api-service:9092' ]
   - job_name: 'prometheus'

src/main/java/com/chrisp1985/UserDataAPI/controller/UserController.java

@@ -2,6 +2,7 @@
 
 import com.chrisp1985.UserDataAPI.data.User;
 import com.chrisp1985.UserDataAPI.service.UserDataService;
+import lombok.extern.slf4j.Slf4j;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
@@ -13,6 +14,7 @@
 
 @RestController
 @RequestMapping("/api/v1/user")
+@Slf4j
 public class UserController {
 
     private final UserDataService userDataService;
@@ -29,6 +31,7 @@ public ResponseEntity<Mono<User>> getUserJpa(@PathVariable String entryId) {
 
     @GetMapping(value = "/r2dbc")
     public ResponseEntity<Flux<User>> getUsersR2jdbc() {
+        log.info("User request made.");
         return ResponseEntity.ok(userDataService.getAllUsers());
     }
 

src/main/java/com/chrisp1985/UserDataAPI/data/User.java

@@ -1,6 +1,9 @@
 package com.chrisp1985.UserDataAPI.data;
 
 import jakarta.persistence.Entity;
+import jakarta.persistence.GeneratedValue;
+import jakarta.persistence.GenerationType;
+import jakarta.persistence.Id;
 import lombok.AllArgsConstructor;
 import lombok.Builder;
 import lombok.Data;
@@ -15,7 +18,8 @@
 @NoArgsConstructor
 @Entity
 public class User {
-    @NotNull
+    @Id
+    @GeneratedValue(strategy = GenerationType.IDENTITY)
     Integer id;
 
     @NotBlank

src/main/resources/application-dev.yml

@@ -28,11 +28,16 @@ spring:
 management:
   endpoints:
     web:
-      exposure:
-        include: health, info, prometheus
-  info:
-    env:
-      enabled: true
+      exposure.include: "health,prometheus"
+      base-path: /
+      path-mapping.prometheus: "metrics"
+    jmx.exposure.exclude: "*"
+  metrics:
+    enable.jvm: true
+    distribution:
+      percentiles.http.server.requests: 0.5, 0.9, 0.95, 0.99, 0.999
+      slo:
+        "[http.server.requests]": "10ms,50ms,100ms,200ms,500ms,1s,5s,10s,30s"
 
 logging:
   level:

src/main/resources/application-prod.yml

@@ -28,11 +28,16 @@ spring:
 management:
   endpoints:
     web:
-      exposure:
-        include: health, info, prometheus
-  info:
-    env:
-      enabled: true
+      exposure.include: "health,prometheus"
+      base-path: /
+      path-mapping.prometheus: "metrics"
+    jmx.exposure.exclude: "*"
+  metrics:
+    enable.jvm: true
+    distribution:
+      percentiles.http.server.requests: 0.5, 0.9, 0.95, 0.99, 0.999
+      slo:
+        "[http.server.requests]": "10ms,50ms,100ms,200ms,500ms,1s,5s,10s,30s"
 
 logging:
   level:

src/main/resources/db/migration/V5__Create_stored_procedures.sql

@@ -0,0 +1,8 @@
+DELIMITER //
+
+CREATE PROCEDURE GetAllUsers()
+BEGIN
+    SELECT * FROM user;
+END //
+
+DELIMITER ;

src/main/resources/grafana.png

@@ -8,6 +8,7 @@
 import org.junit.runner.RunWith;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.boot.test.autoconfigure.web.reactive.WebFluxTest;
+import org.springframework.boot.test.autoconfigure.web.servlet.WebMvcTest;
 import org.springframework.boot.test.mock.mockito.MockBean;
 import org.springframework.cache.Cache;
 import org.springframework.cache.CacheManager;