# thomasvitale/spring-cloud-gateway-resilience-security-observability architecture

> Architecture diagram of the GitHub repository thomasvitale/spring-cloud-gateway-resilience-security-observability, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-11-08). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/thomasvitale/spring-cloud-gateway-resilience-security-observability
- Repository: https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability

## Overview

##### Project type and purpose
- This is a small microservices demo built with Spring Boot and Spring Cloud Gateway.
- It shows how to use an API Gateway (edge-service) to route client traffic, enforce OAuth2/OIDC security, apply resilience patterns, and export observability data.

##### File structure
- Top-level:
- compose.yml – Docker/Podman compose setup including Keycloak and observability services.
- platform/keycloak/full-realm-config.json – Keycloak realm configuration.
- edge-service/… – Spring Boot API gateway (Spring Cloud Gateway + WebFlux + Resilience4J + Spring Security).
- book-service/… – Spring Boot “business” microservice (CRUD books).
- Common patterns: both services use Gradle wrappers, application.yml, test folders, and Micrometer/OpenTelemetry integrations.

##### README for additional insights
- The gateway: entry point on port 9000, handles routing, resilience (circuit breakers, retries, rate-limiters), security via OAuth2/OpenID Connect.
- The book service: on port 9001, protected by gateway authentication.
- Observability: logs, metrics, traces exported via OTLP → Grafana (started automatically with Arconia Dev Services).
- Keycloak for identity server.

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% Clients
    Clients["Clients\n(Browser/Mobile)"]:::client

    %% Edge Service
    subgraph "Edge Service (API Gateway)" 
        direction TB
        Gateway["Spring Cloud Gateway"]:::frontend
        Routing["Routing Module"]:::frontend
        SecurityFilter["Security Filter\n(OAuth2/OIDC)"]:::frontend
        ResilienceFilter["Resilience Filter\n(Circuit Breaker, Retry, Rate Limiter)"]:::frontend
        SessionStore["Redis Reactive\n(Session Store)"]:::frontend
        ObservEdge["OpenTelemetry Metrics & Traces"]:::observ
    end

    %% Book Service
    subgraph "Book Service (Business Microservice)"
        direction TB
        BookService["Spring Boot REST API"]:::backend
        Actuator["Actuator Endpoints\n(Metrics/Traces)"]:::observ
    end

    %% Compose Network
    subgraph "Compose Network" 
        direction TB
        Keycloak["Keycloak\n(OIDC Identity Provider)"]:::platform
        subgraph "Observability Stack"
            direction TB
            OTLP["OTLP Collector"]:::platform
            Grafana["Grafana"]:::platform
        end
    end

    %% Connections
    Clients -->|"HTTP Requests"| Gateway
    Gateway -->|"Validate Token"| Keycloak
    Keycloak -->|"UserInfo"| Gateway
    Gateway -->|"Route Requests"| BookService
    Gateway -->|"Report Metrics/Traces"| OTLP
    BookService -->|"Report Metrics/Traces"| OTLP
    OTLP -->|"Visualize"| Grafana

    %% Internal Edge Service Flow
    Gateway --> Routing
    Routing --> SecurityFilter
    SecurityFilter --> ResilienceFilter
    ResilienceFilter --> SessionStore
    SessionStore --> ObservEdge
    ObservEdge --> OTLP

    %% Internal Book Service Flow
    BookService --> Actuator
    Actuator --> OTLP

    %% Click Events - Edge Service
    click Gateway "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/tree/main/edge-service/"
    click EdgeServiceApplication "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/edge-service/src/main/java/com/thomasvitale/edgeservice/EdgeServiceApplication.java"
    click EdgeConfig "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/edge-service/src/main/resources/application.yml"

    %% Click Events - Book Service
    click BookService "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/tree/main/book-service/"
    click BookServiceApplication "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/book-service/src/main/java/com/thomasvitale/bookservice/BookServiceApplication.java"
    click BookConfig "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/book-service/src/main/resources/application.yml"

    %% Click Events - Compose & Keycloak
    click Compose "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/compose.yml"
    click Keycloak "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/platform/keycloak/full-realm-config.json"

    %% Click Events - Gradle Wrappers & Build Files
    click EdgeGradleWrapper "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/tree/main/edge-service/gradlew"
    click EdgeGradleWrapperBat "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/edge-service/gradlew.bat"
    click EdgeGradleProps "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/edge-service/gradle/wrapper/gradle-wrapper.properties"
    click EdgeBuild "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/edge-service/build.gradle"

    click BookGradleWrapper "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/tree/main/book-service/gradlew"
    click BookGradleWrapperBat "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/book-service/gradlew.bat"
    click BookGradleProps "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/book-service/gradle/wrapper/gradle-wrapper.properties"
    click BookBuild "https://github.com/thomasvitale/spring-cloud-gateway-resilience-security-observability/blob/main/book-service/build.gradle"

    %% Styles
    classDef client fill:#f2f2f2,stroke:#333,stroke-width:1px;
    classDef frontend fill:#cce5ff,stroke:#004085,stroke-width:1px;
    classDef backend fill:#d4edda,stroke:#155724,stroke-width:1px;
    classDef platform fill:#d1ecf1,stroke:#0c5460,stroke-width:1px;
    classDef observ fill:#fff3cd,stroke:#856404,stroke-width:1px;
```
