Skip to content

Add mermaid architecture diagrams to samples missing an architecture image #114

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
paolosalvatori merged 1 commit into from
Aug 11, 2026
Merged

Add mermaid architecture diagrams to samples missing an architecture image #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 35 additions & 18 deletions samples/eventhubs-eventgrid/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,24 +9,41 @@ Blob Storage as Avro. The moment an archive lands, Event Hubs raises
notification **into a second event hub**, and a Function App triggered on that hub downloads the
archive, aggregates it per device, and writes summaries to a curated hub.

```
devices ──▶ telemetry hub ──── Capture (60s window) ────▶ Avro archive in Blob Storage
│ │
│ Microsoft.EventHub.CaptureFileCreated
│ ▼
│ Event Grid system topic
│ │
│ subscription, EventHub destination
│ ▼
│ capture-notifications hub
│ │
│ Event Hubs trigger
│ ▼
└───────────── archive read back ──────────── Function App
│
Event Hubs output binding
▼
curated hub
## Architecture

The following diagram illustrates the architecture of the solution:

```mermaid
flowchart LR
devices["Devices<br/>telemetry_producer.py"]

subgraph ehns["Event Hubs namespace"]
telemetry[["telemetry hub<br/>4 partitions, Capture enabled"]]
notifications[["capture-notifications hub<br/>2 partitions"]]
curated[["curated hub<br/>2 partitions"]]
end

subgraph storage["Storage Account"]
archive[("telemetry-archive container<br/>Avro archives")]
end

subgraph eventgrid["Event Grid"]
topic["System topic<br/>(over the namespace)"]
subscription["capture-to-eventhub subscription<br/>(Event Hub destination)"]
end

subgraph funcapp["Function App"]
processor["CaptureProcessor<br/>(Event Hubs trigger)"]
end

devices -->|"1: AMQP, partition key = device_id"| telemetry
telemetry -->|"2: Capture (60 s window, Avro)"| archive
telemetry -->|"3: Microsoft.EventHub.CaptureFileCreated"| topic
topic --> subscription
subscription -->|"4: delivered as an event"| notifications
notifications -->|"5: trigger (capture-processor group)"| processor
processor -->|"6: read archive (data.fileUrl)"| archive
processor -->|"7: per-device summaries (output binding)"| curated
```

## Why this shape
Expand Down
66 changes: 44 additions & 22 deletions samples/eventhubs/python/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,28 +10,50 @@ The sample is built around the properties that make Event Hubs different from a

## Architecture

```
Producers (outside Azure) LocalStack for Azure
┌───────────────────────┐ ┌──────────────────────────────────────────────┐
│ POS terminals │ AMQP │ Event Hubs namespace (Standard, Kafka on) │
│ producer_amqp.py ├───────►│ │
│ │ │ payments hub ─ 4 partitions ─── Capture ───┼──► Blob Storage
│ Legacy gateway │ Kafka │ consumer groups: │ Avro archives
│ producer_kafka.py ├───────►│ fraud-detector ──┐ analytics audit │ (cold path)
│ │ │ │ │
│ ATM / IoT devices │ HTTPS │ ▼ │
│ producer_http.py ├───────►│ Function App (Python) │
└───────────────────────┘ │ Event Hubs trigger │
│ fraud rules ──────┐ │
│ ▼ │
│ fraud-alerts hub ─ 2 partitions │
│ ▲ │
│ Key Vault: connection strings │ │
│ Schema Registry: Avro contract│ │
│ App Insights + Log Analytics │ │
│ │ │
│ Web App ── operations dashboard │
└──────────────────────────────────────────────┘
The following diagram illustrates the architecture of the solution:

```mermaid
flowchart LR
subgraph producers["External producers"]
pos["POS terminals<br/>producer_amqp.py"]
gateway["Legacy gateway<br/>producer_kafka.py"]
atm["ATM / IoT devices<br/>producer_http.py"]
end

subgraph ehns["Event Hubs namespace (Standard, Kafka enabled)"]
payments[["payments hub<br/>4 partitions<br/>groups: fraud-detector, analytics, audit"]]
alerts[["fraud-alerts hub<br/>2 partitions"]]
registry["Schema Registry<br/>payments-schemas (Avro)"]
end

subgraph funcapp["Function App"]
detector["FraudDetector<br/>(Event Hubs trigger, batched)"]
end

subgraph storage["Storage Account"]
archive[("payments-archive container<br/>Avro archives, cold path")]
checkpoints[("checkpoint blobs")]
end

kv["Key Vault<br/>connection-string secrets<br/>(stored at deploy)"]
dashboard["Web App<br/>operations dashboard"]
monitor["Application Insights +<br/>Log Analytics"]

pos -->|"1: AMQP"| payments
gateway -->|"1: Kafka"| payments
atm -->|"1: HTTPS"| payments
producers -.->|"register Avro contract"| registry

payments -->|"2: trigger (fraud-detector group)"| detector
detector -->|"3: alerts (output binding)"| alerts
detector -.->|"checkpoints"| checkpoints
payments -->|"Capture (60 s / 10 MB, Avro)"| archive

dashboard -.->|"partition state, alerts, schemas"| ehns
dashboard -.->|"checkpoints, archives"| storage
ehns -.-> kv
funcapp -.->|"telemetry"| monitor
dashboard -.->|"telemetry"| monitor
```

**Deployment flow.** The deploy script creates Log Analytics and Application Insights, a
Expand Down
17 changes: 17 additions & 0 deletions samples/servicebus/java/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,23 @@ This sample demonstrates a Java Spring Boot application that sends and receives

## Architecture

The following diagram illustrates the architecture of the solution:

```mermaid
flowchart LR
subgraph host["Host machine"]
app["Spring Boot app<br/>ServiceBusSenderClient + @ServiceBusListener"]
end

subgraph sbns["Service Bus namespace (Standard)"]
queue[["myqueue"]]
end

app -->|"1: send 'Hello, World!'"| queue
queue -->|"2: deliver to @ServiceBusListener"| app
app -.->|"authenticates with AZURE_SERVICEBUS_CONNECTION_STRING"| sbns
```

The solution is composed of the following Azure resources:

1. [Azure Resource Group](https://learn.microsoft.com/en-us/azure/azure-resource-manager/management/manage-resource-groups-cli): A logical container scoping all resources in this sample.
Expand Down