Merge pull request #56 from Dalguring/feature/monitoring

feature: PLG + Prometheus 통합 모니터링 환경 구축

Author: Dalguring

.github/workflows/github-actions-rentify-api.yml

@@ -50,14 +50,14 @@ jobs:
           tags: | 
             ${{ secrets.DOCKERHUB_USERNAME }}/universal-device-rental:latest
 
-      - name: Copy docker-compose.yml to GCP
+      - name: Copy files to GCP
         if: github.event_name == 'push' && github.ref == 'refs/heads/main'
         uses: appleboy/scp-action@v1
         with:
           host: ${{ secrets.GCP_HOST }}
           username: ${{ secrets.GCP_USERNAME }}
           key: ${{ secrets.GCP_SSH_KEY }}
-          source: "docker-compose.yml"
+          source: "docker-compose.yml,monitoring/**"
           target: "/home/${{ secrets.GCP_USERNAME }}/ecommerce-project/infra"
 
       - name: Deploy to GCP

.gitignore

@@ -47,3 +47,6 @@ out/
 
 ### Run File ###
 /start-tunnel.*
+
+### Log File ###
+/logs

docker-compose.yml

@@ -32,6 +32,7 @@ services:
       - "80:8080"
     volumes:
       - upload_data:/app/uploads
+      - app_logs:/app/logs
     environment:
       TZ: Asia/Seoul
       SPRING_PROFILES_ACTIVE: dev
@@ -50,13 +51,54 @@ services:
       MAIL_USERNAME: ${MAIL_USERNAME}
       MAIL_PASSWORD: ${MAIL_PASSWORD}
 
+      LOGGING_FILE_NAME: /app/logs/application.log
+
       JAVA_OPTS: >-
         -Duser.timezone=Asia/Seoul
         -Xms512m
         -Xmx512m
         -XX:+UseG1GC
         -XX:MaxGCPauseMillis=200
 
+  prometheus:
+    image: prom/prometheus:latest
+    container_name: prometheus
+    volumes:
+      - ./monitoring/prometheus.yml:/etc/prometheus/prometheus.yml
+    command:
+      - '--config.file=/etc/prometheus/prometheus.yml'
+
+  loki:
+    image: grafana/loki:latest
+    container_name: loki
+    volumes:
+      - ./monitoring/loki-config.yaml:/etc/loki/local-config.yaml
+    command: -config.file=/etc/loki/local-config.yaml
+
+  promtail:
+    image: grafana/promtail:latest
+    container_name: promtail
+    volumes:
+      - ./monitoring/promtail-config.yaml:/etc/promtail/config.yml
+      - app_logs:/app/logs:ro
+    command: -config.file=/etc/promtail/config.yml
+
+  grafana:
+    image: grafana/grafana:latest
+    container_name: grafana
+    ports:
+      - "3000:3000"
+    environment:
+      - GF_SECURITY_ADMIN_USER=admin
+      - GF_SECURITY_ADMIN_PASSWORD=admin
+    depends_on:
+      - prometheus
+      - loki
+    volumes:
+      - grafana_data:/var/lib/grafana
+
 volumes:
   postgres_data:
   upload_data:
+  app_logs:
+  grafana_data:

monitoring/loki-config.yaml

@@ -0,0 +1,25 @@
+auth_enabled: false
+
+server:
+  http_listen_port: 3100
+
+common:
+  path_prefix: /loki
+  storage:
+    filesystem:
+      chunks_directory: /loki/chunks
+      rules_directory: /loki/rules
+  replication_factor: 1
+  ring:
+    kvstore:
+      store: inmemory
+
+  schema_config:
+    configs:
+      - from: 2020-10-24
+        store: boltdb-shipper
+        object_store: filesystem
+        schema: v11
+        index:
+          prefix: index_
+          period: 24h

monitoring/prometheus.yml

@@ -0,0 +1,8 @@
+global:
+  scrape_interval: 5s
+
+scrape_configs:
+  - job_name: 'rentify-api'
+    metrics_path: '/actuator/prometheus'
+    static_configs:
+      - targets: ['spring:8080']

monitoring/promtail-config.yaml

@@ -0,0 +1,18 @@
+server:
+  http_listen_port: 9000
+  grpc_listen_port: 0
+
+positions:
+  filename: /tmp/positions.yaml
+
+clients:
+  - url: http://loki:3100/loki/api/v1/push
+
+scrape_configs:
+  - job_name: system
+    static_configs:
+      - targets:
+          - localhost
+        labels:
+          job: rentify-api-logs
+          __path__: /app/logs/*.log

src/main/java/com/rentify/rentify_api/common/config/SecurityConfig.java

@@ -45,6 +45,7 @@ public SecurityFilterChain securityFilterChain(HttpSecurity http) throws Excepti
             .httpBasic(AbstractHttpConfigurer::disable)
             .authorizeHttpRequests(auth -> auth
                 .requestMatchers(SWAGGER_WHITELIST).permitAll()
+                .requestMatchers("/actuator/**").permitAll()
                 // User API
                 .requestMatchers(HttpMethod.POST, "/api/users").permitAll()
                 .requestMatchers(HttpMethod.POST, "/api/users/login").permitAll()

src/main/resources/application-dev.yaml

@@ -29,6 +29,8 @@ logging:
     root: INFO
     com.rentify.rentify_api: INFO
     org.hibernate.SQL: ERROR
+  file:
+    name: /app/logs/application.log
 
 file:
   upload:

src/main/resources/application-local.yaml

@@ -29,6 +29,8 @@ logging:
     root: INFO
     com.rentify.rentify_api: DEBUG
     org.hibernate.SQL: DEBUG
+  file:
+    name: logs/application-local.log
 
 file:
   upload:

src/main/resources/application.yaml

@@ -59,4 +59,22 @@ file:
   upload:
     path: ${FILE_UPLOAD_PATH}
   base:
-    url: ${FILE_BASE_URL}
+    url: ${FILE_BASE_URL}
+
+management:
+  endpoints:
+    web:
+      exposure:
+        include: prometheus, health, info, metrics
+  endpoint:
+    health:
+      show-details: always
+  metrics:
+    tags:
+      application: ${spring.application.name}
+
+logging:
+  logback:
+    rollingpolicy:
+      max-history: 7
+      max-file-size: 10MB