Merge pull request #3441 from ProgrammeVitam/story_15290

GiooDev · web-flow · commit 7e03024bd429 · 2026-01-05T16:16:26.000+01:00
Story #15290: Adding VitamUI's scrape_configs for prometheus-server.
diff --git a/deployment/ansible-vitamui-extra/vitamui_extra.yml b/deployment/ansible-vitamui-extra/vitamui_extra.yml
@@ -22,3 +22,10 @@
   gather_facts: yes
   roles:
     - merge_index_apache
+
+# Deploy prometheus scrape configs for VitamUI metrics
+- hosts: hosts_prometheus | default([])
+  gather_facts: false
+  roles:
+    - prometheus_scrape_configs
+  tags: prometheus
diff --git a/deployment/ansible-vitamui/app_api_gateway.yml b/deployment/ansible-vitamui/app_api_gateway.yml
@@ -10,4 +10,3 @@
     password_keystore: "{{ keystores_server_api_gateway }}"
     password_truststore: "{{ truststores_client_external }}"
     vitam_cert: "{{ vitam_certs.vitamui }}"
-    consul_tags: "api-gateway, api, internal"
diff --git a/deployment/ansible-vitamui/app_archive_search.yml b/deployment/ansible-vitamui/app_archive_search.yml
@@ -10,4 +10,3 @@
     password_keystore: "{{ keystores_server_archive_search }}"
     password_truststore: "{{ truststores_client_external }}"
     vitam_cert: "{{ vitam_certs.vitamui }}"
-    consul_tags: "archive-search, api"
diff --git a/deployment/ansible-vitamui/app_collect.yml b/deployment/ansible-vitamui/app_collect.yml
@@ -10,4 +10,3 @@
     password_keystore: "{{ keystores_server_collect }}"
     password_truststore: "{{ truststores_client_external }}"
     vitam_cert: "{{ vitam_certs.vitamui }}"
-    consul_tags: "collect, api"
diff --git a/deployment/ansible-vitamui/app_ingest.yml b/deployment/ansible-vitamui/app_ingest.yml
@@ -10,4 +10,3 @@
     password_keystore: "{{ keystores_server_ingest }}"
     password_truststore: "{{ truststores_client_external }}"
     vitam_cert: "{{ vitam_certs.vitamui }}"
-    consul_tags: "ingest, api"
diff --git a/deployment/ansible-vitamui/app_pastis.yml b/deployment/ansible-vitamui/app_pastis.yml
@@ -10,4 +10,3 @@
     password_keystore: "{{ keystores_server_pastis }}"
     password_truststore: "{{ truststores_client_external }}"
     vitam_cert: "{{ vitam_certs.vitamui }}"
-    consul_tags: "pastis, api"
diff --git a/deployment/ansible-vitamui/app_referential.yml b/deployment/ansible-vitamui/app_referential.yml
@@ -10,4 +10,3 @@
     password_keystore: "{{ keystores_server_referential }}"
     password_truststore: "{{ truststores_client_external }}"
     vitam_cert: "{{ vitam_certs.vitamui }}"
-    consul_tags: "referential, api"
diff --git a/deployment/ansible-vitamui/vitamui_apps.yml b/deployment/ansible-vitamui/vitamui_apps.yml
@@ -11,9 +11,7 @@
     vitamui_certificate_type: server
     password_keystore: "{{ keystores_server_security }}"
     password_truststore: "{{ truststores_server }}"
-    consul_tags: "security, api"
-  tags:
-    - security
+  tags: security
 
 # External apps
 - hosts: hosts_vitamui_iam
@@ -27,9 +25,7 @@
     password_keystore: "{{ keystores_server_iam }}"
     password_truststore: "{{ truststores_client_external }}"
     vitam_cert: "{{ vitam_certs.vitamui }}"
-    consul_tags: "iam, api"
-  tags:
-    - iam
+  tags: iam
 
 - hosts: hosts_cas_server
   gather_facts: no
@@ -42,6 +38,4 @@
     vitamui_certificate_type: external
     password_keystore: "{{ keystores_server_cas_server }}"
     password_truststore: "{{ truststores_client_external }}"
-    consul_tags: "cas-server, cas, external"
-  tags:
-    - cas-server
+  tags: cas-server
diff --git a/deployment/environments/hosts-ui.example b/deployment/environments/hosts-ui.example
@@ -150,7 +150,7 @@ hosts_vitamui_logstash
 hosts_vitamui_consul_server
 
 [hosts_vitamui_logstash]
-# EDIT: Optionnal
+# EDIT: Optional
 # Add nodes in this group if you want to start a dedicated logstash cluster for vitamui
 # otherwise leave this group empty (by default logs will be sent to vitam's logstash cluster)
 
@@ -169,6 +169,7 @@ hosts_vitamui_consul_server
 hosts_consul_server
 hosts_elasticsearch_log
 hosts_logstash
+hosts_prometheus
 reverse
 
 # MINIMUM REQUIRED IN ZONE VITAM
@@ -182,8 +183,11 @@ reverse
 [hosts_logstash]
 # EDIT: Mandatory when 'syslog.name: filebeat' is used and [hosts_vitamui_logstash] is not defined
 
+[hosts_prometheus]
+# EDIT: Optional used for deploying scraping configurations for VitamUI Components
+
 [reverse]
-# EDIT: Optionnal
+# EDIT: Optional
 # This group need vitam_reverse_external_dns variable to be configured
 # WARNING: Do not use in production environments
 # WARNING: Do not collocate with [hosts_vitamui_reverseproxy]
@@ -194,7 +198,7 @@ reverse
 # ZONE TOOLS
 ################################################################################
 [hosts_browse]
-# EDIT: Optionnal
+# EDIT: Optional
 # WARNING: Do not use in production environments
 
 
diff --git a/deployment/roles/prometheus_scrape_configs/handlers/main.yml b/deployment/roles/prometheus_scrape_configs/handlers/main.yml
@@ -0,0 +1,7 @@
+---
+
+- name: "prometheus-server - restart service"
+  systemd:
+    name: vitam-prometheus
+    state: restarted
+    daemon_reload: true
diff --git a/deployment/roles/prometheus_scrape_configs/tasks/main.yml b/deployment/roles/prometheus_scrape_configs/tasks/main.yml
@@ -0,0 +1,21 @@
+---
+
+- name: Check that the prometheus scrape_configs directory exist
+  file:
+    path: "{{ prometheus_server_config_path }}/scrape_configs"
+    state: directory
+    owner: "{{ vitam_defaults.users.vitam }}"
+    group: "{{ vitam_defaults.users.group }}"
+    mode: "{{ '0755' if install_mode == 'container' else vitam_defaults.folder.folder_permission }}"
+  notify: "prometheus-server - restart service"
+
+- name: Copy scrape config files
+  template:
+    src: "{{ item }}"
+    dest: "{{ prometheus_server_config_path }}/scrape_configs/{{ item | basename | regex_replace('\\.j2$') }}"
+    owner: "{{ vitam_defaults.users.vitam }}"
+    group: "{{ vitam_defaults.users.group }}"
+    mode: "{{ '0644' if install_mode == 'container' else vitam_defaults.folder.conf_permission }}"
+  with_fileglob:
+    - "templates/*.yml.j2"
+  notify: "prometheus-server - restart service"
diff --git a/deployment/roles/prometheus_scrape_configs/templates/vitamui_metrics.yml.j2 b/deployment/roles/prometheus_scrape_configs/templates/vitamui_metrics.yml.j2
@@ -0,0 +1,101 @@
+#jinja2: lstrip_blocks: True
+scrape_configs:
+{% if groups['hosts_vitamui_api_gateway'] | length > 0 %}
+
+  - job_name: vitamui-api-gateway
+    metrics_path: {{ vitamui.api_gateway.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_api_gateway'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.api_gateway.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_vitamui_iam'] | length > 0 %}
+
+  - job_name: vitamui-iam
+    metrics_path: {{ vitamui.iam.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_iam'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.iam.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_vitamui_ingest'] | length > 0 %}
+
+  - job_name: vitamui-ingest
+    metrics_path: {{ vitamui.ingest.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_ingest'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.ingest.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_vitamui_archive_search'] | length > 0 %}
+
+  - job_name: vitamui-archive-search
+    metrics_path: {{ vitamui.archive_search.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_archive_search'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.archive_search.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_vitamui_collect'] | length > 0 %}
+
+  - job_name: vitamui-collect
+    metrics_path: {{ vitamui.collect.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_collect'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.collect.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_vitamui_referential'] | default([]) | length > 0 %}
+
+  - job_name: vitamui-referential
+    metrics_path: {{ vitamui.referential.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_referential'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.referential.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_vitamui_security'] | default([]) | length > 0 %}
+
+  - job_name: vitamui-security
+    metrics_path: {{ vitamui.security.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_security'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.security.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_vitamui_pastis'] | length > 0 %}
+
+  - job_name: vitamui-pastis
+    metrics_path: {{ vitamui.pastis.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_vitamui_pastis'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.pastis.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
+{% if groups['hosts_cas_server'] | length > 0 %}
+
+  - job_name: vitamui-cas-server
+    metrics_path: {{ vitamui.cas_server.metrics_path | default(default_prometheus_metrics_path) }}
+    static_configs:
+      {% for host in groups['hosts_cas_server'] %}
+      - targets: ["{{ hostvars[host]['ip_admin'] }}:{{ vitamui.cas_server.port_admin }}"]
+        labels:
+          hostname: {{ host.split(".")[0] }}
+      {% endfor %}
+{% endif %}
diff --git a/deployment/roles/prometheus_scrape_configs/vars/main.yml b/deployment/roles/prometheus_scrape_configs/vars/main.yml
@@ -0,0 +1,4 @@
+---
+
+prometheus_server_config_path: "{{ vitam_defaults.folder.root_path | default('/vitam') }}/conf/prometheus"
+default_prometheus_metrics_path: "{{ prometheus.metrics_path | default('/actuator/prometheus') }}"
diff --git a/deployment/roles/vitamui/templates/api-gateway/application.yml.j2 b/deployment/roles/vitamui/templates/api-gateway/application.yml.j2
@@ -1,3 +1,4 @@
+#jinja2: lstrip_blocks: True
 server:
   address: {{ ip_service }}
   port: {{ vitamui_struct.server_port | default('8090') }}
@@ -13,15 +14,18 @@ server:
   max-http-request-header-size: {{ vitamui_struct.server_max_http_header_size | default('10KB') }}
 
 management:
-  endpoints:
-    web:
-      exposure:
-        include: "*"
   server:
     address: {{ ip_admin }}
     port: {{ vitamui_struct.port_admin | default('7090') }}
     ssl:
       enabled: false
+  endpoints:
+    web:
+      exposure:
+        include: health,metrics,prometheus
+  metrics:
+    tags:
+      application: ${spring.application.name}
 
 authn:
   client-certificate-header-name: {{ vitamui.api_gateway.client_certificate_header_name | default('x-ssl-cert') }}
@@ -36,22 +40,22 @@ spring:
       enabled: true
       host: {{ hostvars[inventory_hostname][consul.network] if (inventory_hostname in groups['hosts_vitamui_consul_server'] or inventory_hostname in groups['hosts_consul_server']) else 'localhost' }}
       discovery:
-        serviceName: vitamui-{{ vitamui_struct.vitamui_component }}
+        serviceName: ${spring.application.name}
         preferIpAddress: true
         ipAddress: ${server.address}
         healthCheckUrl: http://${management.server.address}:${management.server.port}/actuator/health
-        tags: {{ consul_tags }}
-        instanceId: {{ vitamui_struct.vitamui_component }}-${server.port}-${spring.cloud.client.hostname}
+        tags: vitamui, {{ vitamui_struct.vitamui_component }}
+        instanceId: ${spring.application.name}-${spring.cloud.client.hostname}-${server.port}
     gateway:
       server:
         webflux:
           httpclient:
             wiretap: false
             ssl:
               trustedX509Certificates:
-{% for cert_file in copied_cert_files %}
-              - {{ vitamui_folder_conf }}/{{ cert_file }}
-{% endfor %}
+              {% for cert_file in copied_cert_files %}
+                - {{ vitamui_folder_conf }}/{{ cert_file }}
+              {% endfor %}
           httpserver:
             wiretap: false
           globalcors:
@@ -110,7 +114,6 @@ spring:
                   /archive-search-api/logbooks/operations/**,
                   /archive-search-api/accesscontracts/**,
 
-
                   /pastis-api/ui/**,
                   /pastis-api/security,
                   /pastis-api/userinfos/**,
diff --git a/deployment/roles/vitamui/templates/archive-search/application.yml.j2 b/deployment/roles/vitamui/templates/archive-search/application.yml.j2
@@ -1,16 +1,18 @@
 #jinja2: lstrip_blocks: True
 spring:
+  application:
+    name: vitamui-{{ vitamui_struct.vitamui_component }}
   cloud:
     consul:
       enabled: true
       host: {{ hostvars[inventory_hostname][consul.network] if (inventory_hostname in groups['hosts_vitamui_consul_server'] or inventory_hostname in groups['hosts_consul_server']) else 'localhost' }}
       discovery:
-        serviceName: vitamui-{{ vitamui_struct.vitamui_component }}
+        serviceName: ${spring.application.name}
         preferIpAddress: true
         ipAddress: ${server.address}
         healthCheckUrl: http://${management.server.address}:${management.server.port}/actuator/health
-        tags: {{ consul_tags }}
-        instanceId: {{ vitamui_struct.vitamui_component }}-${server.port}-${spring.cloud.client.hostname}
+        tags: vitamui, {{ vitamui_struct.vitamui_component }}
+        instanceId: ${spring.application.name}-${spring.cloud.client.hostname}-${server.port}
   data:
     mongodb:
       uri: mongodb://{{ mongodb.archivesearch.user }}:{{ mongodb.archivesearch.password }}@{{ mongodb.host }}:{{ mongodb.mongod_port }}/{{ mongodb.archivesearch.db }}?replicaSet={{ mongod_replicaset_name }}&connectTimeoutMS={{ mongod_client_connect_timeout_ms }}
@@ -49,6 +51,13 @@ management:
     port: {{ vitamui_struct.port_admin }}
     ssl:
       enabled: false
+  endpoints:
+    web:
+      exposure:
+        include: health,metrics,prometheus
+  metrics:
+    tags:
+      application: ${spring.application.name}
 
 gateway:
   enabled: true
diff --git a/deployment/roles/vitamui/templates/cas-server/application.yml.j2 b/deployment/roles/vitamui/templates/cas-server/application.yml.j2
@@ -1,16 +1,18 @@
+#jinja2: lstrip_blocks: True
 spring:
+  application:
+    name: vitamui-{{ vitamui_struct.vitamui_component }}
   cloud:
     consul:
       enabled: true
       host: {{ hostvars[inventory_hostname][consul.network] if (inventory_hostname in groups['hosts_vitamui_consul_server'] or inventory_hostname in groups['hosts_consul_server']) else 'localhost' }}
       discovery:
-        serviceName: vitamui-{{ vitamui_struct.vitamui_component }}
+        serviceName: ${spring.application.name}
         preferIpAddress: true
         ipAddress: ${server.address}
         healthCheckUrl: http://${management.server.address}:${management.server.port}/actuator/health
-        tags: {{ consul_tags }}
-
-spring.application.name: cas-server
+        tags: vitamui, {{ vitamui_struct.vitamui_component }}
+        instanceId: ${spring.application.name}-${spring.cloud.client.hostname}-${server.port}
 
 server:
 {% if vitamui_struct.secure | default(secure) | bool == true %}
@@ -47,6 +49,13 @@ management:
     port: {{ vitamui_struct.port_admin }}
     ssl:
       enabled: false
+  endpoints:
+    web:
+      exposure:
+        include: health,metrics,prometheus
+  metrics:
+    tags:
+      application: ${spring.application.name}
 
 vitamui.cas.tenant.identifier: {{ vitamui_platform_informations.cas_tenant }}
 vitamui.cas.identity: cas
diff --git a/deployment/roles/vitamui/templates/collect/application.yml.j2 b/deployment/roles/vitamui/templates/collect/application.yml.j2
diff --git a/deployment/roles/vitamui/templates/iam/application.yml.j2 b/deployment/roles/vitamui/templates/iam/application.yml.j2
diff --git a/deployment/roles/vitamui/templates/ingest/application.yml.j2 b/deployment/roles/vitamui/templates/ingest/application.yml.j2
diff --git a/deployment/roles/vitamui/templates/pastis/application.yml.j2 b/deployment/roles/vitamui/templates/pastis/application.yml.j2
diff --git a/deployment/roles/vitamui/templates/referential/application.yml.j2 b/deployment/roles/vitamui/templates/referential/application.yml.j2
diff --git a/deployment/roles/vitamui/templates/security/application.yml.j2 b/deployment/roles/vitamui/templates/security/application.yml.j2
diff --git a/docs/fr/migration/upgrade_v9_1.md b/docs/fr/migration/upgrade_v9_1.md
