MarginaliaSearch/code
Viktor Lofgren 6e7649b5f7 (loader) Mitigate fragile paging behavior
IndexJournalWriterPagingImpl was modified to not page on number of entries written, but number of (equivalent uncompressed) bytes written.

Since the failure mode if too much data is written per file is quiet corruption of the index, the former behavior was extremely fragile.  The new behavior should consistently ensure that the data is sufficiently small to not cause any integer rollovers.

The change in 6dcc20038c was reverted, as there is really no sane reason to have this configurable in software.
2024-02-05 21:05:03 +01:00
..
api (*) Add download-sample action, refactor file storage 2024-01-25 13:36:30 +01:00
common (minor) Fix test and improve error message 2024-01-31 11:53:41 +01:00
features-convert (sample-exporter) Add some limits on sizes and lengths 2024-01-25 11:51:53 +01:00
features-crawl (crawler) Improve meta-tag redirect handling, add tests for redirects. 2024-02-01 20:30:43 +01:00
features-index (loader) Mitigate fragile paging behavior 2024-02-05 21:05:03 +01:00
features-qs (search/index) Add a new keyword "count" 2023-12-25 20:38:29 +01:00
features-search (*) Replace EC_DOMAIN_LINK table with files and in-memory caching 2024-01-08 15:53:13 +01:00
libraries (index) Fix consistency between RandomFileAssembler implementations 2024-02-05 21:01:32 +01:00
process-models (crawler) Extract additional configuration properties 2024-01-20 10:36:04 +01:00
processes (sideload) Add special handling for sideloaded wiki documents 2024-02-02 21:22:07 +01:00
services-application (query-api) Make the search set identifier a string value in the API 2024-01-16 10:55:24 +01:00
services-core (*) Add flag for disabling ASCII flattening 2024-01-31 11:50:59 +01:00
tools (control) Fully automatic conversion 2024-01-22 13:03:24 +01:00
readme.md (docs) Improve architectural documentation 2023-11-30 21:38:57 +01:00

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.

image

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

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.

Tools

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.

  • common elements for creating a service, a client etc.
  • libraries containing non-search specific code.
    • array - large memory mapped area library
    • btree - static btree library