feat: monitoring (#411)

* chore: versions make command ## In `code` * Split versions for api and web-ui * Add make get-*-version * Add make get-versions * Refacto methods et make help exposition * feat: expose actuator * feat: expose metrics and threaddump with authentication * chore: ignore custom properties * chore: removed timed * chore: update api version to 8.0.2 * chore: update web-ui version to 8.0.2 * chore: remove unused import * chore: custom sample properties * feat: add influxdb support
Decathlon · Mar 9, 2021 · 494ed24 · 494ed24
1 parent c10f426
commit 494ed24
Show file tree

Hide file tree

Showing 43 changed files with 104 additions and 208 deletions.
diff --git a/charts/candidate/Chart.yaml b/charts/candidate/Chart.yaml
@@ -1,6 +1,6 @@
 apiVersion: v2
 name: ara
-version: 8.0.0-rc.0
+version: 8.0.2-rc.0
 home: https://github.com/Decathlon/ara
 description: |
     ARA helps you to fight against regressions by letting it preanalyze your non-regression tests runs,

diff --git a/charts/candidate/templates/ingress.yaml b/charts/candidate/templates/ingress.yaml
@@ -31,7 +31,7 @@ spec:
       - backend:
           serviceName: {{ printf "%s-%s" .Chart.Name "api" }}
           servicePort: http-port
-        path: /actuator/info
+        path: /actuator
       - backend:
           serviceName: {{ printf "%s-%s" .Chart.Name "api" }}
           servicePort: http-port

diff --git a/charts/candidate/values.yaml b/charts/candidate/values.yaml
@@ -8,7 +8,7 @@ api:
     image:
         registry: docker.io
         repository: decathlon/ara-api
-        # tag:
+        tag: 8.0.2
         imagePullPolicy: IfNotPresent
     replicas: 1
     annotations: {}
@@ -44,7 +44,7 @@ ui:
     image:
         registry: docker.io
         repository: decathlon/ara-web-ui
-        # tag:
+        tag: 8.0.2
         imagePullPolicy: IfNotPresent
     replicas: 1
     annotations: {}

diff --git a/code/Makefile b/code/Makefile
@@ -5,45 +5,34 @@
 DOCKER_REGISTRY?=docker.io
 # Forks may use name/ara for their tests
 IMAGE_NAME?=decathlon/ara
-VERSION?=latest
+API_VERSION?=latest
+WEB_UI_VERSION?=latest
 
-API_IMAGE=${DOCKER_REGISTRY}/${IMAGE_NAME}-api:${VERSION}
-WEB_UI_IMAGE=${DOCKER_REGISTRY}/${IMAGE_NAME}-web-ui:${VERSION}
-
-DIFF_LABEL = "to-be-changed"
-DATE_WITH_TIME := $(shell /bin/date "+%Y%m%d%H%M%S")
-BASE?=h2
+API_IMAGE=${DOCKER_REGISTRY}/${IMAGE_NAME}-api:${API_VERSION}
+WEB_UI_IMAGE=${DOCKER_REGISTRY}/${IMAGE_NAME}-web-ui:${WEB_UI_VERSION}
 
 #####################################
 ##           QUICK START           ##
 #####################################
 
 start: ## Start ARA
 	@echo '-- Start ARA --'
-	@export VERSION=$(VERSION); docker-compose up -d
+	@export API_VERSION=$(API_VERSION); export WEB_UI_VERSION=$(WEB_UI_VERSION); docker-compose up -d
 
 stop: ## Stop ARA
 	@echo '-- Stop ARA --'
-	@export VERSION=$(VERSION); docker-compose down
+	@export API_VERSION=$(API_VERSION); export WEB_UI_VERSION=$(WEB_UI_VERSION); docker-compose down
 
 
 # RUN BY MODULE
 
-run-db: ## Run database
-	@echo '-- Run database --'
-	@export VERSION=$(VERSION); docker-compose up ara-db
+run-%: ## Run module
+	@echo '-- Run $* --'
+	@export API_VERSION=$(API_VERSION); export WEB_UI_VERSION=$(WEB_UI_VERSION); docker-compose up $(OPT) ara-$*
 
-run-api: ## Run api
-	@echo '-- Run ara-api --'
-	@export VERSION=$(VERSION); docker-compose up ara-api
-
-run-web-ui: ## Run web-ui
-	@echo '-- Run ara-web-ui --'
-	@export VERSION=$(VERSION); docker-compose up ara-web-ui
-
-start-db: ## Start database in background
-	@echo '-- Start database in background --'
-	@export VERSION=$(VERSION); docker-compose up -d ara-db
+stop-%: ## Stop module
+	@echo '-- Stop $* --'
+	@docker-compose up $(OPT) ara-$*
 
 #####################################
 ##            BUILD APP            ##
@@ -52,7 +41,7 @@ start-db: ## Start database in background
 build: ## Build ARA in parallel
 	@$(MAKE) build-full -j2 -k
 
-build-full: build-api build-web-ui ## Build ARA
+build-full: build-api build-web-ui
 
 about-web-ui:
 	@mkdir -p web-ui/static/version
@@ -84,7 +73,7 @@ about-api:
     								  -f about.jq > \
     								  api/server/src/main/resources/static/api/version/about.json
 
-build-api: ## Build ara-api
+build-api: about-api ## Build ara-api
 	@echo '-- Build ${API_IMAGE} --'
 	@docker build -t ${API_IMAGE} api
 
@@ -93,6 +82,9 @@ build-api: ## Build ara-api
 #####################################
 
 # CREATE LIQUIBASE DIFF
+DIFF_LABEL = "to-be-changed"
+DATE_WITH_TIME := $(shell /bin/date "+%Y%m%d%H%M%S")
+BASE?=h2
 
 liquibase-diff: build-api up-migration ## Create a liquibase diff file -- DIFF_LABEL required, BASE to specify database
 ifeq ($(BASE),h2)
@@ -122,38 +114,53 @@ stop-migration-stack:
 
 # UPDATE ARA VERSION
 
-update-chart-version:
+get-versions: ## Give ARA version
+	@echo -n 'chart stable: '
+	@$(MAKE) get-chart-version TARGET_CHART=stable
+	@echo -n 'chart candidate: '
+	@$(MAKE) get-chart-version TARGET_CHART=candidate
+	@echo -n 'api: '
+	@$(MAKE) get-api-version
+	@echo -n 'web-ui: '
+	@$(MAKE) get-web-ui-version
+
+TARGET_CHART?=stable
+get-chart-version:
+	@echo $$(cat ../charts/$(TARGET_CHART)/Chart.yaml | grep version | sed -e 's/version: //')
+
+update-chart-version: ## Update chart version
 	@echo '-- Update Helm Chart version --'
-	@sed -i'.old' 's/^version:.*$\/version: $(VERSION)/' ../charts/stable/Chart.yaml
+	@sed -i'.old' 's/^version:.*$\/version: $(VERSION)/' ../charts/$(TARGET_CHART)/Chart.yaml
+
+get-api-version:
+	@$(MAKE) -C api get-version
 
-update-maven-version:
+update-api-version: ## Update api version
 	@echo '-- Update Maven version --'
 	@mvn --batch-mode -f api/pom.xml -s api/settings.xml release:update-versions -DautoVersionSubmodules=true -DdevelopmentVersion=$(VERSION)-SNAPSHOT
 	@mvn --batch-mode -f api/pom.xml -s api/settings.xml versions:set -DremoveSnapshot -DprocessAllModules
 
-update-front-version:
+get-web-ui-version:
+	@$(MAKE) -C web-ui get-version
+
+update-web-ui-version: ## Update web-ui version
 	@echo '-- Update Web-UI version --'
 	@npm --prefix web-ui version $(VERSION)
 
-commit-version:
-	@echo '-- Commit new version --'
-	@git add -A && git commit -m "⬆️  Upgrade to $(VERSION)" && git push
-
-
 #####################################
 ##            HELM PART            ##
 #####################################
 
-helm-tempate: ## Helm template
+helm-tempate:
 	@helm template ../charts/stable --debug
 
-helm-install: ## Helm install ara-local
+helm-install:
 	@helm install --create-namespace --namespace ara ara-local ../charts/stable
 
-helm-upgrade: ## Helm upgrade ara-local
+helm-upgrade:
 	@helm upgrade --namespace ara ara-local ../charts/stable
 
-helm-uninstall: ## Helm uninstall ara-local
+helm-uninstall:
 	@helm uninstall --namespace ara ara-local
 
 .PHONY: help

diff --git a/code/api/database/pom.xml b/code/api/database/pom.xml
@@ -28,7 +28,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-database</artifactId>
-    <version>8.0.1</version>
+    <version>8.0.2</version>
 
     <name>ARA Database</name>
     <description>
@@ -39,6 +39,8 @@
     <properties>
         <java.version>14</java.version>
         <querydsl.version>4.3.1</querydsl.version>
+        <diffChangeLogFile>src/main/resources/db/changelog/changes/XX/to-be-changed.yaml</diffChangeLogFile>
+        <liquibasePropertyFile>src/main/resources/liquibase-XX.properties</liquibasePropertyFile>
     </properties>
 
     <dependencies>

diff --git a/code/api/generated-cucumber-report/pom.xml b/code/api/generated-cucumber-report/pom.xml
@@ -27,7 +27,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-generated-cucumber-report</artifactId>
-    <version>8.0.1</version>
+    <version>8.0.2</version>
 
     <name>ARA Cucumber</name>
     <description>

diff --git a/code/api/jacoco-aggregation/pom.xml b/code/api/jacoco-aggregation/pom.xml
@@ -3,7 +3,7 @@
     <parent>
         <artifactId>ara-parent</artifactId>
         <groupId>com.decathlon.ara</groupId>
-        <version>8.0.1</version>
+        <version>8.0.2</version>
     </parent>
     <modelVersion>4.0.0</modelVersion>
 

diff --git a/code/api/lib/pom.xml b/code/api/lib/pom.xml
@@ -27,7 +27,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-lib</artifactId>
-    <version>8.0.1</version>
+    <version>8.0.2</version>
 
     <properties>
         <java.version>14</java.version>

diff --git a/code/api/pom.xml b/code/api/pom.xml
@@ -28,7 +28,7 @@
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-parent</artifactId>
     <packaging>pom</packaging>
-    <version>8.0.1</version>
+    <version>8.0.2</version>
 
     <name>ARA API</name>
     <description>

diff --git a/code/api/server/.gitignore b/code/api/server/.gitignore
@@ -30,3 +30,4 @@ src/test/resources/dbunit/freshly-created-dataset-to-rename.xml
 # application.properties
 ## authentication
 /src/main/resources/application-auth.properties
+/src/main/resources/application-custom.properties
diff --git a/code/api/server/pom.xml b/code/api/server/pom.xml
@@ -28,7 +28,7 @@
 
     <groupId>com.decathlon.ara</groupId>
     <artifactId>ara-server</artifactId>
-    <version>8.0.1</version>
+    <version>8.0.2</version>
 
     <name>ARA Server</name>
     <description>
@@ -59,6 +59,10 @@
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-starter-actuator</artifactId>
         </dependency>
+        <dependency>
+            <groupId>io.micrometer</groupId>
+            <artifactId>micrometer-registry-influx</artifactId>
+        </dependency>
 
         <!-- Tests and development -->
         <dependency>
@@ -112,32 +116,6 @@
             <artifactId>commons-lang3</artifactId>
         </dependency>
 
-        <!-- From JHipster -->
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-core</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-annotation</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-json</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-jcache</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-jvm</artifactId>
-        </dependency>
-        <dependency>
-            <groupId>io.dropwizard.metrics</groupId>
-            <artifactId>metrics-servlet</artifactId>
-        </dependency>
-
         <!-- Entity<->DTO Mappapplicater classes generation -->
         <dependency>
             <groupId>org.mapstruct</groupId>

diff --git a/...api/server/src/main/java/com/decathlon/ara/configuration/security/SecurityConfigurer.java b/...api/server/src/main/java/com/decathlon/ara/configuration/security/SecurityConfigurer.java
@@ -68,7 +68,7 @@ protected void configure(HttpSecurity http) throws Exception {
             .sessionManagement().sessionCreationPolicy(SessionCreationPolicy.STATELESS)
         .and()
             .authorizeRequests()//NOSONAR
-                .antMatchers("/actuator/**").permitAll()
+                .antMatchers("/actuator/info", "/actuator/health").permitAll()
                 .antMatchers("/auth/**").permitAll()
                 .antMatchers(swaggerResources).permitAll()
                 .anyRequest().authenticated()

diff --git a/...i/server/src/main/java/com/decathlon/ara/scenario/cucumber/resource/CucumberResource.java b/...i/server/src/main/java/com/decathlon/ara/scenario/cucumber/resource/CucumberResource.java
@@ -17,7 +17,7 @@
 
 package com.decathlon.ara.scenario.cucumber.resource;
 
-import com.codahale.metrics.annotation.Timed;
+
 import com.decathlon.ara.scenario.cucumber.upload.CucumberScenarioUploader;
 import com.decathlon.ara.service.ProjectService;
 import com.decathlon.ara.service.exception.BadRequestException;
@@ -56,7 +56,6 @@ public class CucumberResource {
      * @return OK on success, INTERNAL_SERVER_ERROR on processing error
      */
     @PostMapping("scenarios/upload/{sourceCode}")
-    @Timed
     public ResponseEntity<Void> uploadScenarios(@PathVariable String projectCode, @PathVariable String sourceCode, @Valid @RequestBody String json) {
         try {
             cucumberScenarioUploader.uploadCucumber(projectService.toId(projectCode), sourceCode, json);

diff --git a/...api/server/src/main/java/com/decathlon/ara/scenario/cypress/resource/CypressResource.java b/...api/server/src/main/java/com/decathlon/ara/scenario/cypress/resource/CypressResource.java
@@ -17,7 +17,7 @@
 
 package com.decathlon.ara.scenario.cypress.resource;
 
-import com.codahale.metrics.annotation.Timed;
+
 import com.decathlon.ara.scenario.cucumber.bean.Feature;
 import com.decathlon.ara.scenario.cypress.upload.CypressScenarioUploader;
 import com.decathlon.ara.service.ProjectService;
@@ -49,7 +49,6 @@ public class CypressResource {
     private final CypressScenarioUploader cypressScenarioUploader;
 
     @PostMapping("scenarios/upload/{sourceCode}")
-    @Timed
     public ResponseEntity<Void> uploadCucumberScenarios(@PathVariable String projectCode, @PathVariable String sourceCode, @RequestBody List<Feature> features) {
         try {
             cypressScenarioUploader.uploadScenarios(projectService.toId(projectCode), sourceCode, features);

diff --git a/...api/server/src/main/java/com/decathlon/ara/scenario/postman/resource/PostmanResource.java b/...api/server/src/main/java/com/decathlon/ara/scenario/postman/resource/PostmanResource.java
@@ -17,7 +17,7 @@
 
 package com.decathlon.ara.scenario.postman.resource;
 
-import com.codahale.metrics.annotation.Timed;
+
 import com.decathlon.ara.Entities;
 import com.decathlon.ara.scenario.postman.upload.PostmanScenarioUploader;
 import com.decathlon.ara.service.ProjectService;
@@ -54,7 +54,6 @@ public class PostmanResource {
     private final PostmanScenarioUploader postmanScenarioUploader;
 
     @PostMapping("scenarios/upload/{sourceCode}")
-    @Timed
     public ResponseEntity<Void> uploadScenarios(@PathVariable String projectCode,
                                                 @PathVariable String sourceCode,
                                                 @RequestParam("file") MultipartFile file) {

diff --git a/code/api/server/src/main/java/com/decathlon/ara/web/rest/CommunicationResource.java b/code/api/server/src/main/java/com/decathlon/ara/web/rest/CommunicationResource.java
@@ -17,7 +17,7 @@
 
 package com.decathlon.ara.web.rest;
 
-import com.codahale.metrics.annotation.Timed;
+
 import com.decathlon.ara.Entities;
 import com.decathlon.ara.service.ProjectService;
 import com.decathlon.ara.service.exception.NotFoundException;
@@ -61,7 +61,6 @@ public class CommunicationResource {
      * @return the ResponseEntity with status 200 (OK) and the list of entities in body
      */
     @GetMapping("")
-    @Timed
     public ResponseEntity<List<CommunicationDTO>> getAll(@PathVariable String projectCode) {
         try {
             return ResponseEntity.ok().body(service.findAll(projectService.toId(projectCode)));
@@ -71,7 +70,6 @@ public ResponseEntity<List<CommunicationDTO>> getAll(@PathVariable String projec
     }
 
     @GetMapping("/{code}")
-    @Timed
     public ResponseEntity<CommunicationDTO> getOneByCode(@PathVariable String projectCode, @PathVariable String code) {
         try {
             return ResponseEntity.ok().body(service.findOneByCode(projectService.toId(projectCode), code));
@@ -81,7 +79,6 @@ public ResponseEntity<CommunicationDTO> getOneByCode(@PathVariable String projec
     }
 
     @PutMapping("/{code}")
-    @Timed
     public ResponseEntity<CommunicationDTO> update(@PathVariable String projectCode,
                                                    @PathVariable String code,
                                                    @Valid @RequestBody CommunicationDTO dtoToUpdate) {