Skip to content

Commit 159b79d

Browse files
Updated docs to point to Arroyo fork (#163)
1 parent b7dd3cd commit 159b79d

4 files changed

Lines changed: 5 additions & 11 deletions

File tree

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ ASAPQuery has four main components: the **asap-planner** generates sketch config
5050

5151
- **[asap-planner](asap-planner/)** - Analyzes a PromQL query workload and auto-generates sketch configurations for asap-sketch-ingest and asap-query-engine
5252
- **[asap-sketch-ingest](asap-sketch-ingest/)** - Deploys Arroyo streaming pipelines that continuously compute and publish sketches from live metrics
53-
- **[arroyo](arroyo/)** - Fork of the [Arroyo](https://github.com/ArroyoSystems/Arroyo) stream processing engine that runs the sketch-building SQL pipelines
53+
- **[arroyo](https://github.com/ProjectASAP/arroyo)** - Fork of the [Arroyo](https://github.com/ArroyoSystems/arroyo) stream processing engine that runs the sketch-building SQL pipelines
5454
- **[asap-query-engine](asap-query-engine/)** - Intercepts incoming PromQL queries and serves them from pre-computed sketches, falling back to Prometheus for unsupported queries
5555

5656
### Repository Structure
@@ -59,8 +59,8 @@ ASAPQuery has four main components: the **asap-planner** generates sketch config
5959
├── asap-quickstart/ # Self-contained demo (start here!)
6060
├── asap-planner/ # Auto-configuration service
6161
├── asap-sketch-ingest/ # Arroyo pipeline deployer
62-
├── arroyo/ # Fork of Arroyo stream processing engine
6362
└── asap-query-engine/ # Query serving engine
63+
# Note: Arroyo fork lives at https://github.com/ProjectASAP/arroyo
6464
```
6565

6666
## Coming soon

asap-quickstart/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ This quickstart simulates a typical monitoring deployment with components you mi
1414

1515
Then it adds ASAPQuery's components on top:
1616
- **Query Engine** - Prometheus-compatible API with sketch-based acceleration
17-
- **Arroyo + asap-sketch-ingest** - Streaming engine with pipelines configured for building sketches
17+
- **[Arroyo](https://github.com/ProjectASAP/arroyo) + asap-sketch-ingest** - Streaming engine with pipelines configured for building sketches
1818
- **Kafka** - Message broker for streaming data from Arroyo to the Query Engine
1919
- **asap-planner** - Automatically configures sketches from PromQL queries
2020

docs/01-getting-started/architecture.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ graph LR
184184
| Component | Purpose | Technology | Location |
185185
|-----------|---------|------------|----------|
186186
| **asap-query-engine** | Answers PromQL queries using sketches | Rust | `asap-query-engine/` |
187-
| **Arroyo** | Stream processing for building sketches | Rust (forked) | `arroyo/` |
187+
| **Arroyo** | Stream processing for building sketches | Rust (forked) | [github.com/ProjectASAP/arroyo](https://github.com/ProjectASAP/arroyo) |
188188
| **asap-sketch-ingest** | Configures Arroyo pipelines from config | Python | `asap-sketch-ingest/` |
189189
| **asap-planner** | Auto-determines sketch parameters | Python | `asap-planner/` |
190190
| **Kafka** | Message broker for sketch distribution | Apache Kafka | (external) |
@@ -259,12 +259,6 @@ ASAPQuery/
259259
│ │ └── tests/ # Integration tests
260260
│ └── docs/ # QueryEngine dev docs
261261
262-
├── arroyo/ # Arroyo streaming engine (forked)
263-
│ └── crates/
264-
│ └── arroyo-connectors/
265-
│ ├── prometheus_remote_write_with_schema/
266-
│ └── prometheus_remote_write_optimized/
267-
268262
├── asap-sketch-ingest/ # Pipeline configurator
269263
│ ├── run_arroyosketch.py # Main script
270264
│ ├── templates/ # Jinja2 SQL templates

docs/02-components/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ This document provides an overview of all ASAP components and links to detailed
77
| Component | Purpose | Technology | Links |
88
|-----------|---------|------------|-------|
99
| **asap-query-engine** | Answers PromQL queries using sketches | Rust | [Details](query-engine.md) · [Code](../../asap-query-engine/) · [Dev Docs](../../asap-query-engine/docs/README.md) |
10-
| **Arroyo** | Stream processing for building sketches | Rust (forked) | [Details](arroyo.md) · [Code](../../arroyo/) |
10+
| **Arroyo** | Stream processing for building sketches | Rust (forked) | [Details](arroyo.md) · [Code](https://github.com/ProjectASAP/arroyo) |
1111
| **asap-sketch-ingest** | Configures Arroyo pipelines from config | Python | [Details](arroyosketch.md) · [Code](../../asap-sketch-ingest/) · [README](../../asap-sketch-ingest/README.md) |
1212
| **asap-planner** | Auto-determines sketch parameters | Python | [Details](controller.md) · [Code](../../asap-planner/) · [README](../../asap-planner/README.md) |
1313
| **Exporters** | Generate synthetic metrics for testing | Rust/Python | [Details](exporters.md) · [Code](../../asap-tools/prometheus-exporters/) · [README](../../asap-tools/prometheus-exporters/README.md) |

0 commit comments

Comments
 (0)