# pablitovicente/mqtt-load-generator architecture

> Architecture diagram of the GitHub repository pablitovicente/mqtt-load-generator, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-11-19). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/pablitovicente/mqtt-load-generator
- Repository: https://github.com/pablitovicente/mqtt-load-generator

## Overview

MQTT Load Generator is a Go command-line tool for publishing load, counting subscriptions, and printing received payloads. The main workflow runs through `pub` (also the default command): validate settings, connect all clients, publish messages, track acknowledgements and latency, then report results. The `sub` and `dump` commands provide separate receive-side workflows. The graph includes progress/reporting and broker access; some subsystem links are based on README descriptions because their implementation excerpts were not provided.

Main entry points: [`internal/cli`](https://github.com/pablitovicente/mqtt-load-generator/tree/main/internal/cli) (CLI commands), [`internal/broker/paho.go`](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/broker/paho.go) (MQTT client adapter), [`internal/mqttload/publish.go`](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish.go) (Publish workload), [`internal/mqttload/subscribe.go`](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/subscribe.go) (Count messages)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["Command interface"]
  node_main["Signal-aware entry<br/>[main.go]"]
  node_commands["CLI commands"]
  node_brokerconfig["Connection setup<br/>[broker.go]"]
end

subgraph group_runs["MQTT workloads"]
  node_publish["Publish workload<br/>[publish.go]"]
  node_connect["Client coordination<br/>[connect.go]"]
  node_subscribe["Count messages<br/>[subscribe.go]"]
  node_dump["Print payloads<br/>[dump.go]"]
  node_payload["Payload generation<br/>[payload.go]"]
  node_pubstats["Publish statistics<br/>[publish_stats.go]"]
  node_substats["Subscribe statistics<br/>[subscribe_stats.go]"]
end

subgraph group_broker["Broker access"]
  node_brokerclient["MQTT client adapter<br/>[paho.go]"]
  node_tls["TLS configuration<br/>[tls.go]"]
  node_mqttbroker{{"MQTT broker"}}
end

subgraph group_output["Progress and reports"]
  node_progress["Progress tracking"]
  node_display["Progress display<br/>[publish.go]"]
  node_subdisplay["Subscribe display<br/>[subscribe.go]"]
  node_dumpdisplay["Payload formatting<br/>[dump.go]"]
  node_reports["Run reports<br/>[publish_report.go]"]
  node_subreport["Subscribe report"]
end

node_user(("Operator"))

node_user -->|"runs"| node_main
node_main -->|"executes"| node_commands
node_commands -->|"configures"| node_brokerconfig
node_commands -->|"starts clients"| node_connect
node_commands -->|"runs workload"| node_publish
node_connect -->|"connects clients"| node_brokerclient
node_brokerconfig -->|"dials"| node_brokerclient
node_brokerclient -->|"exchanges MQTT"| node_mqttbroker
node_brokerclient -.->|"uses TLS"| node_tls
node_publish -.->|"generates payloads"| node_payload
node_publish -.->|"records outcomes"| node_pubstats
node_publish -->|"publishes messages"| node_brokerclient
node_publish -.->|"updates progress"| node_progress
node_commands -->|"runs sub"| node_subscribe
node_commands -->|"runs dump"| node_dump
node_subscribe -->|"subscribes"| node_brokerclient
node_dump -->|"subscribes"| node_brokerclient
node_subscribe -->|"records arrivals"| node_substats
node_commands -->|"starts display"| node_display
node_commands -->|"starts display"| node_subdisplay
node_commands -->|"formats messages"| node_dumpdisplay
node_display -->|"reads progress"| node_progress
node_commands -->|"writes report"| node_reports
node_commands -->|"writes report"| node_subreport
node_subdisplay -->|"shows counts"| node_substats

click node_main "https://github.com/pablitovicente/mqtt-load-generator/blob/main/cmd/main.go"
click node_commands "https://github.com/pablitovicente/mqtt-load-generator/tree/main/internal/cli"
click node_brokerconfig "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/cli/broker.go"
click node_publish "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish.go"
click node_connect "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/connect.go"
click node_subscribe "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/subscribe.go"
click node_dump "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/dump.go"
click node_payload "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/payload.go"
click node_pubstats "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish_stats.go"
click node_substats "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/subscribe_stats.go"
click node_brokerclient "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/broker/paho.go"
click node_tls "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/broker/tls.go"
click node_progress "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish_progress.go"
click node_display "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/display/publish.go"
click node_subdisplay "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/display/subscribe.go"
click node_dumpdisplay "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/display/dump.go"
click node_reports "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish_report.go"
click node_subreport "https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/subscribe_report.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_main,node_commands,node_brokerconfig toneBlue
class node_publish,node_connect,node_subscribe,node_dump,node_payload,node_pubstats,node_substats toneAmber
class node_brokerclient,node_tls,node_mqttbroker toneMint
class node_progress,node_display,node_subdisplay,node_dumpdisplay,node_reports,node_subreport toneRose
class node_user toneIndigo
```

## Components

### Command interface

- [Signal-aware entry](https://github.com/pablitovicente/mqtt-load-generator/blob/main/cmd/main.go): `cmd/main.go`
- [CLI commands](https://github.com/pablitovicente/mqtt-load-generator/tree/main/internal/cli): `internal/cli`
- [Connection setup](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/cli/broker.go): `internal/cli/broker.go`

### MQTT workloads

- [Publish workload](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish.go): `internal/mqttload/publish.go`
- [Client coordination](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/connect.go): `internal/mqttload/connect.go`
- [Count messages](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/subscribe.go): `internal/mqttload/subscribe.go`
- [Print payloads](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/dump.go): `internal/mqttload/dump.go`
- [Payload generation](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/payload.go): `internal/mqttload/payload.go`
- [Publish statistics](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish_stats.go): `internal/mqttload/publish_stats.go`
- [Subscribe statistics](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/subscribe_stats.go): `internal/mqttload/subscribe_stats.go`

### Broker access

- [MQTT client adapter](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/broker/paho.go): `internal/broker/paho.go`
- [TLS configuration](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/broker/tls.go): `internal/broker/tls.go`
- **MQTT broker**

### Progress and reports

- [Progress tracking](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish_progress.go): `internal/mqttload/publish_progress.go`
- [Progress display](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/display/publish.go): `internal/display/publish.go`
- [Subscribe display](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/display/subscribe.go): `internal/display/subscribe.go`
- [Payload formatting](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/display/dump.go): `internal/display/dump.go`
- [Run reports](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/publish_report.go): `internal/mqttload/publish_report.go`
- [Subscribe report](https://github.com/pablitovicente/mqtt-load-generator/blob/main/internal/mqttload/subscribe_report.go): `internal/mqttload/subscribe_report.go`

### Other components

- **Operator**

## Connections

- Operator → Signal-aware entry: runs (evidence: `README.md`)
- Signal-aware entry → CLI commands: executes (evidence: `cmd/main.go`)
- CLI commands → Connection setup: configures (evidence: `internal/cli/publish.go`)
- CLI commands → Client coordination: starts clients (evidence: `internal/cli/publish.go`)
- CLI commands → Publish workload: runs workload (evidence: `internal/cli/publish.go`)
- Client coordination → MQTT client adapter: connects clients (evidence: `internal/mqttload/connect.go`)
- Connection setup → MQTT client adapter: dials (evidence: `internal/cli/broker.go`)
- MQTT client adapter → MQTT broker: exchanges MQTT (evidence: `README.md`)
- MQTT client adapter → TLS configuration: uses TLS
- Publish workload → Payload generation: generates payloads
- Publish workload → Publish statistics: records outcomes
- Publish workload → MQTT client adapter: publishes messages (evidence: `internal/mqttload/publish.go`)
- Publish workload → Progress tracking: updates progress
- CLI commands → Count messages: runs sub (evidence: `internal/cli/subscribe.go`)
- CLI commands → Print payloads: runs dump (evidence: `internal/cli/dump.go`)
- Count messages → MQTT client adapter: subscribes (evidence: `internal/mqttload/subscribe.go`)
- Print payloads → MQTT client adapter: subscribes (evidence: `README.md`)
- Count messages → Subscribe statistics: records arrivals (evidence: `internal/mqttload/subscribe.go`)
- CLI commands → Progress display: starts display (evidence: `internal/cli/publish.go`)
- CLI commands → Subscribe display: starts display (evidence: `internal/cli/subscribe.go`)
- CLI commands → Payload formatting: formats messages (evidence: `internal/cli/dump.go`)
- Progress display → Progress tracking: reads progress (evidence: `internal/display/publish.go`)
- CLI commands → Run reports: writes report (evidence: `README.md`)
- CLI commands → Subscribe report: writes report (evidence: `internal/cli/subscribe.go`)
- Subscribe display → Subscribe statistics: shows counts (evidence: `internal/display/subscribe.go`)
