Skip to content

Commit 01afd5f

Browse files
committed
chore: update README
Signed-off-by: Dane Hunt <dhunt3800@gmail.com>
1 parent d0ad432 commit 01afd5f

2 files changed

Lines changed: 24 additions & 19 deletions

File tree

‎README.md‎

Lines changed: 24 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -87,14 +87,30 @@ Argus runs until it receives `SIGINT` or `SIGTERM`.
8787

8888
```text
8989
argus/
90-
├── main.go # Config, entry point, recovery pipeline orchestration
91-
├── monitor.go # Log monitor — subscribes to amq.rabbitmq.log
92-
├── manager.go # DiagnosticsManager — RabbitMQ Management API client
93-
├── health.go # EvaluateQueueHealth — three-gate health classification
94-
├── locate.go # Find a queue's Raft data directory by decoding ETF meta files
95-
├── carve.go # Extract AMQP payloads from .segment / .wal files
96-
├── delete.go # HTTP queue deletion with rabbitmqctl fallback
97-
└── republish.go # Republish recovered payloads via AMQP
90+
├── main.go # Entry point — wires up config, monitor, and recovery pipeline
91+
├── internal/
92+
│ ├── runtime/
93+
│ │ └── config.go # Environment-driven configuration loading
94+
│ ├── monitor/
95+
│ │ └── monitor.go # Log monitor — subscribes to amq.rabbitmq.log
96+
│ ├── broker/
97+
│ │ ├── diagnostics.go # DiagnosticsManager — RabbitMQ Management API client
98+
│ │ ├── delete.go # HTTP queue deletion with rabbitmqctl fallback
99+
│ │ └── types.go # RabbitNode/RabbitQueue API response models, EvaluateQueueHealth
100+
│ ├── recovery/
101+
│ │ ├── pipeline.go # Orchestrates locate → backup → carve → republish → delete
102+
│ │ ├── locate.go # Find a queue's Raft data directory by decoding ETF meta files
103+
│ │ ├── backup.go # Copy WAL files matching a queue's UID into a backup dir
104+
│ │ ├── carve.go # Extract AMQP payloads from .segment / .wal files
105+
│ │ ├── etfscan.go # Low-level ETF tag scanning used by the carver
106+
│ │ ├── wal.go # Ra WAL file record parsing
107+
│ │ ├── copyfile.go # File copy helper
108+
│ │ ├── republish.go # Republish recovered payloads via AMQP
109+
│ │ └── types.go # Shared recovery data types
110+
│ └── testutil/
111+
│ └── testutil.go # Shared test helpers
112+
└── tests/
113+
└── integration/ # Docker-based end-to-end integration tests
98114
```
99115

100116
## Limitations & caveats
@@ -110,15 +126,6 @@ argus/
110126
- **Duplicate delivery is possible.** If a message was already acknowledged
111127
before the crash, carving may recover and republish it again.
112128

113-
## Future
114-
115-
- Eliminate the limitation where original headers, content-type and routing
116-
metadata are not recovered.
117-
- Ensure only one node in the RabbitMQ cluster attempts recovery of a queue.
118-
- Manual mode to specify recovery of a specific queue.
119-
- Remove orphaned queues.
120-
- Possible classic queue support.
121-
122129
---
123130

124131
## Contributing

‎rabbitmq.conf‎

Lines changed: 0 additions & 2 deletions
This file was deleted.

0 commit comments

Comments
 (0)