# openbb-finance/uptime architecture

> Architecture diagram of the GitHub repository openbb-finance/uptime, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-06-09). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/openbb-finance/uptime
- Repository: https://github.com/openbb-finance/uptime

## Overview

##### Project type and purpose
- This is an open-source uptime monitor and status-page generator powered by Upptime.
- Purpose: regularly ping a set of external services (OpenBB.co, Bot API, AI backend, etc.), record response times and uptimes, store the data in the repo, and publish a static status page via GitHub Pages.

##### File structure
- Top-level:
- `.github/workflows/` – CI pipelines (Uptime CI, Response Time CI, Graphs CI, Summary CI, Static Site CI)
- `api/` – JSON endpoints of current response-time and uptime metrics (used by Shields)
- `graphs/` – generated PNG graphs for each service over various time ranges
- `history/` – raw YAML history of each check and aggregated summary
- `assets/custom-theme.css` – CSS override for the static page theme
- `README.md`, `LICENSE`, Upptime config (`.upptimerc.yml`)
- Patterns:
- “GitOps” for monitoring: everything lives in Git, including data.
- CI pipelines trigger scheduled jobs → commit metrics → regenerate site.

##### README for additional insights
- Confirms use of GitHub Issues for incidents, Actions for monitoring jobs, Pages for site hosting.
- Lists the monitored URLs and shows the generated Markdown table that becomes the status page.

## Diagram (Mermaid)

```mermaid
flowchart TB
    Scheduler["Scheduler (Cron Trigger)"]:::scheduler

    subgraph "GitHub Actions Workflows"
        UP["Uptime CI Workflow"]:::workflow
        RT["Response Time CI Workflow"]:::workflow
        GR["Graphs CI Workflow"]:::workflow
        SU["Summary CI Workflow"]:::workflow
        STA["Static Site CI Workflow"]:::workflow
    end

    subgraph "External Services"
        OPENBB["openbb.co"]:::external
        DOCS["docs.openbb.co"]:::external
        BOTPLAT["Bot Platform"]:::external
        BOTAPI["Bot API"]:::external
        PRO["OpenBB Pro"]:::external
        PROBE["Pro Backend"]:::external
        AIBACK["AI Backend"]:::external
    end

    API_DATA["api/ (JSON Endpoints)"]:::datastore
    HISTORY["history/ (YAML History)"]:::datastore
    GRAPHS["graphs/ (PNG Graphs)"]:::datastore

    GH_PAGES["GitHub Pages (Status Site)"]:::hosting
    ISSUES["GitHub Issues (Incident Logging)"]:::user
    USERS["End Users"]:::user

    Scheduler --> UP
    Scheduler --> RT

    UP --> OPENBB
    UP --> DOCS
    UP --> BOTPLAT
    UP --> BOTAPI
    UP --> PRO
    UP --> PROBE
    UP --> AIBACK

    RT --> OPENBB
    RT --> DOCS
    RT --> BOTPLAT
    RT --> BOTAPI
    RT --> PRO
    RT --> PROBE
    RT --> AIBACK

    UP --> API_DATA
    RT --> API_DATA

    UP --> HISTORY
    RT --> HISTORY

    HISTORY --> GR
    HISTORY --> SU
    API_DATA --> SU

    GR --> GRAPHS
    GRAPHS --> STA
    SU --> STA

    STA --> GH_PAGES
    GH_PAGES --> USERS

    UP -.->|on failure| ISSUES
    RT -.->|on failure| ISSUES

    click UP "https://github.com/openbb-finance/uptime/blob/master/.github/workflows/uptime.yml"
    click RT "https://github.com/openbb-finance/uptime/blob/master/.github/workflows/response-time.yml"
    click GR "https://github.com/openbb-finance/uptime/blob/master/.github/workflows/graphs.yml"
    click SU "https://github.com/openbb-finance/uptime/blob/master/.github/workflows/summary.yml"
    click STA "https://github.com/openbb-finance/uptime/blob/master/.github/workflows/site.yml"
    click API_DATA "https://github.com/openbb-finance/uptime/tree/master/api/"
    click HISTORY "https://github.com/openbb-finance/uptime/tree/master/history/"
    click GRAPHS "https://github.com/openbb-finance/uptime/tree/master/graphs/"

    classDef workflow fill:#f9d5b3,stroke:#f08a5d,stroke-width:1px
    classDef datastore fill:#d0e6f6,stroke:#004e89,stroke-width:1px
    classDef external fill:#c3f584,stroke:#6a994e,stroke-width:1px
    classDef hosting fill:#e0bbf0,stroke:#5e548e,stroke-width:1px
    classDef scheduler fill:#ffe8d6,stroke:#ff4500,stroke-width:1px
    classDef user fill:#f0f0f0,stroke:#888,stroke-width:1px
```
