fab36d6e63
Adds experimental sideloading support for pusshift.io style reddit data. This dataset is limited to data older than 2023, due to licensing changes making large-scale data extraction difficult. Since the median post quality on reddit is not very good, he sideloader will only load a subset of self-texts and top-level comments that have sufficiently many upvotes. Empirically this appears to mostly return good matches, even if it probably could index more. Tests were written for this, but all require local reddit data which can't be distributed with the source code. If these can not be found, the tests will shortcircuit as OK. They're mostly there for debugging, and it's fine if they don't always run. The change also refactors the sideloading a bit since it was a bit messy. |
||
|---|---|---|
| .. | ||
| api | ||
| common | ||
| features-convert | ||
| features-crawl | ||
| features-index | ||
| features-qs | ||
| features-search | ||
| libraries | ||
| process-models | ||
| processes | ||
| services-application | ||
| services-core | ||
| tools | ||
| readme.md | ||
Code
This is a pretty large and diverse project with many moving parts.
You'll find a short description in each module of what it does and how it relates to other modules. The modules each have names like "library" or "process" or "feature". These have specific meanings. See doc/module-taxonomy.md.
Overview
A map of the most important components and how they relate can be found below.
The core part of the search engine is the index service, which is responsible for storing and retrieving the document data. The index serive is partitioned, along with the executor service, which is responsible for executing processes. At least one instance of each service must be run, but more can be run alongside. Multiple partitions is desirable in production to distribute load across multiple physical drives, as well as reducing the impact of downtime.
Search queries are delegated via the query service, which is a proxy that fans out the query to all eligible index services. The control service is responsible for distributing commands to the executor service, and for monitoring the health of the system. It also offers a web interface for operating the system.
Services
- core services Most of these services are stateful, memory hungry, and doing heavy lifting.
- application services Mostly stateless gateways providing access to the core services.
-
- api - public API
-
- search - marginalia search application
- an internal API
Processes
Processes are batch jobs that deal with data retrieval, processing and loading. These are spawned and orchestrated by the executor service, which is controlled by the control service.
Features
Features are relatively stand-alone components that serve some part of the domain. They aren't domain-independent, but isolated.
Libraries and primitives
Libraries are stand-alone code that is independent of the domain logic.