Skip to content
This repository was archived by the owner on Nov 8, 2026. It is now read-only.

Latest commit

 

History

History
47 lines (38 loc) · 3.08 KB

README.md

File metadata and controls

47 lines (38 loc) · 3.08 KB

Sink documentation

Back to the project

Get started

Guide What you will learn
Docker Compose quickstart Start Sink, MongoDB, and Kafka and verify the public API
Go client Connect an application and read or write typed documents
Store isolation Gateway, per-Store Engine/Worker, deployment and scaling
Architecture and behavior Understand addresses, encoding, batching, ordering, and completion modes
Document write flow Follow one document from an RPC through storage or a Kafka worker

Build an application

Guide What you will learn
Native access Execute backend commands, query, count, scan, and return atomic update results
Lua merge developer guide Write merge programs using the sink.v1 tools
Testing Lua merge programs Test JSON and BSON fixtures with Sink's production Lua runtime
Record addresses Canonical URIs, Store paths and Engine affinity
Merge folding Understand how compatible operations share one storage write
Protocol definition Inspect the authoritative gRPC messages and services

Deploy and operate

Guide What you will learn
Configuration reference Configure named stores, resource limits, Kafka, and process modes
Metrics and health Inspect metrics, label budgets, and dependency health
Internal diagnostic logs Configure warn-level console/OTLP logs, ES labels and bounded failure bodies
Adaptive Store backpressure Dispatch admission, congestion feedback, recovery and independence from application scaling
Batching behavior Understand collection queues, ordering, and capacity
Reliability and recovery Plan idempotence, monitor dependencies, handle failures, and replay dead letters
Production sizing Size Gateway, Engine and Worker against workload and backend capacity

Contribute and qualify changes

Guide What you will learn
Internal logging design Diagnostic logging scope, field contract and reliability boundaries
Contributing Report an issue and prepare a focused pull request
Development Build, lint, generate protobuf code, run tests, and package releases
Lua benchmarks Compare Lua runtime workloads
Public production suite Run public API conformance and sustained fault qualification
Security policy Report a vulnerability privately