# ouzdev/polly-resilience-playground architecture

> Architecture diagram of the GitHub repository ouzdev/polly-resilience-playground, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-01-12). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/ouzdev/polly-resilience-playground
- Repository: https://github.com/ouzdev/polly-resilience-playground

## Overview

##### Main Components

a. Client Layer:
- Guest API (Polly.Resilience.Playground.Guest.API)
- Resilience Strategies Implementation
- Service Layer with Strategy Service

b. External Service Layer:
- PMS API (Property Management System API)
- Endpoints for testing different failure scenarios

c. Monitoring & Observability Stack:
- Grafana for visualization
- Prometheus for metrics collection
- OpenTelemetry Collector

d. Testing Infrastructure:
- K6 Load Testing component

##### Component Relationships

- Guest API making resilient calls to the PMS API
- Metrics flow: Services → OpenTelemetry → Prometheus → Grafana
- Demonstrate how K6 generates load against the system

##### Specific Implementation Details

- Resilience Strategies (Retry, Circuit Breaker, Timeout, Bulkhead, Fallback)
- Service Abstractions (IStrategyService implementation)
- Common Components (ApiResponse, Result, ResilienceKeys)

**┌─────────────────────────────────────────────────────────────┐**
- Load Generation                         │
- (K6 Load Tests)                         │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────────┐**
- Guest API                              │
- ┌─────────────────┐  ┌─────────────────┐  ┌────────────┐  │
- Controllers    │  │ Strategy Service │  │  Resilience│  │
- Resilience  │←→│    - Abstract   │←→│  Patterns  │  │
- Controller  │  │    - Concrete   │  │  (Polly)   │  │
- ┘  └─────────────────┘  └────────────┘  │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────────┐**
- PMS API                                │
- ┌─────────────────┐  ┌─────────────────┐                  │
- Controllers   │  │    Services     │                  │
- ┘  └─────────────────┘                  │
- ┘
- ↓
**┌─────────────────────────────────────────────────────────────┐**
- Monitoring Stack                            │
- ┌─────────────┐  ┌─────────────┐  ┌─────────────────┐     │
- OpenTel   │→│  Prometheus  │→│    Grafana      │     │
- Collector  │  │             │  │   Dashboards    │     │
- ┘  └─────────────┘  └─────────────────┘     │
- ┘

##### Additional Elements

- Network communication paths
- Resilience strategy configuration flows
- Metric collection paths

##### Important Notes

- Separation of concerns between Guest API and PMS API
- Monitoring points where metrics are collected
- Configuration sources and their relationships

## Diagram (Mermaid)

```mermaid
graph TB
    subgraph LoadGen["Load Generation Layer"]
        K6[K6 Load Tests]:::loadtest
    end

    subgraph ClientLayer["Client Layer"]
        GuestAPI[Guest API]:::api
        subgraph GuestComponents["Guest API Components"]
            ResController[Resilience Controller]:::controller
            StratService[Strategy Service]:::service
            ResStrategies[Resilience Strategies]:::strategy
            ResPipeline[Resilience Pipeline]:::pipeline
        end
    end

    subgraph ExternalLayer["External Service Layer"]
        PMSAPI[PMS API]:::api
        subgraph PMSComponents["PMS API Components"]
            StratController[Strategy Controller]:::controller
            PMSService[PMS Service]:::service
        end
    end

    subgraph MonitoringStack["Monitoring & Observability"]
        OTel[OpenTelemetry Collector]:::monitoring
        Prometheus[Prometheus]:::monitoring
        Grafana[Grafana Dashboards]:::monitoring
    end

    K6 -->|Load Testing| GuestAPI
    GuestAPI -->|Makes Resilient Calls| PMSAPI
    ResController -->|Uses| StratService
    StratService -->|Implements| ResStrategies
    ResStrategies -->|Configures| ResPipeline
    PMSAPI -->|Exposes| StratController
    StratController -->|Uses| PMSService

    GuestAPI -->|Metrics| OTel
    PMSAPI -->|Metrics| OTel
    OTel -->|Forwards| Prometheus
    Prometheus -->|Visualizes| Grafana

    %% Click Events
    click GuestAPI "https://github.com/ouzdev/polly-resilience-playground/tree/master/src/Client/Polly.Resilience.Playground.Guest.API/"
    click ResController "https://github.com/ouzdev/polly-resilience-playground/blob/master/src/Client/Polly.Resilience.Playground.Guest.API/Controllers/ResilienceController.cs"
    click StratService "https://github.com/ouzdev/polly-resilience-playground/blob/master/src/Client/Polly.Resilience.Playground.Guest.API/Services/Concrete/StrategyService.cs"
    click ResStrategies "https://github.com/ouzdev/polly-resilience-playground/blob/master/src/Client/Polly.Resilience.Playground.Guest.API/Extensions/Strategies/ResiliencePipelineBuilderExtensions.cs"
    click PMSAPI "https://github.com/ouzdev/polly-resilience-playground/tree/master/src/ExternalService/Polly.Resilience.Playground.PMS.API/"
    click StratController "https://github.com/ouzdev/polly-resilience-playground/blob/master/src/ExternalService/Polly.Resilience.Playground.PMS.API/Controllers/StrategyController.cs"
    click K6 "https://github.com/ouzdev/polly-resilience-playground/blob/master/scripts/k6-load-test/script.js"
    click Grafana "https://github.com/ouzdev/polly-resilience-playground/tree/master/scripts/grafana/"
    click Prometheus "https://github.com/ouzdev/polly-resilience-playground/tree/master/scripts/prometheus/"
    click OTel "https://github.com/ouzdev/polly-resilience-playground/blob/master/scripts/otel-collector/otel-collector-config.yaml"

    %% Styling
    classDef api fill:#2374ab
    classDef controller fill:#48a9a6
    classDef service fill:#4ea5d9
    classDef strategy fill:#44cf6c
    classDef pipeline fill:#44cf6c
    classDef monitoring fill:#e4572e
    classDef loadtest fill:#9b287b

    %% Legend
    subgraph Legend
        API[API Services]:::api
        Controller[Controllers]:::controller
        Service[Services]:::service
        Strategy[Strategies]:::strategy
        Monitor[Monitoring]:::monitoring
        LoadTest[Load Testing]:::loadtest
    end
```
