Documentation

Guides, tutorials, and API reference are maintained on the GitHub Wiki. For questions and discussion, join the community on Zulip.

Quick Start with Docker

The fastest way to explore ChronoLog is through our Docker image:

$ docker pull gnosisrc/chronolog:latest

$ docker run -it --rm --name chronolog gnosisrc/chronolog:latest

$ /home/grc-iit/chronolog_repo/deploy/local_single_user_deploy.sh -d -w /home/grc-iit/chronolog_install/Release

Data Model

ChronoLog organizes data around four core concepts. Understanding these is essential before working with the API.

Chronicle

A named data structure consisting of a collection of events ordered by physical time. Analogous to a topic, stream, or ledger in other systems. Each chronicle is created, acquired, and released by clients -- similar to opening and closing a file.

Event

A single data unit stored as a key-value pair. The key is a ChronoTick (a monotonically increasing integer representing the time distance from the chronicle's creation timestamp). The value is an uninterpreted byte array -- ChronoLog is format-agnostic.

ChronoTick

A monotonically increasing positive integer that serves as the event key. Represents the time distance (offset) from a chronicle's base timestamp. Physical time is the ordering mechanism -- no centralized sequencer assigns these values.

Story

A division (partition) of a chronicle -- a sorted, immutable collection of events. Stories are optimized for sequential access and serve as the unit of data movement between storage tiers. ChronoGrapher builds stories from individual events.

GitHub Repository

Source code and issues

Docker Hub

gnosisrc/chronolog

Zulip Community

Chat and support

Guides

Getting Started

Introduction and first steps with ChronoLog.

Installation

Detailed installation guides and requirements.

Configuration

Configuration options and settings.

Deployment

Local, distributed, and SLURM deployment strategies.

Client API

C++ and Python API reference and usage examples.

Client Examples

Code examples and use cases.

Architecture

System architecture and design principles.

Plugins

Plugin development and integration.

Tutorials

1

First Steps with ChronoLog

Get started with your first deployment.
2

Running a Performance Test

Benchmark and test ChronoLog performance.
3

Docker Single-Node

Deploy on a single node using Docker.
4

Docker Multi-Node

Deploy across multiple nodes using Docker.

AI Integration

ChronoLog MCP Server

Model Context Protocol server for connecting AI agents to ChronoLog, part of the IOWarp Agent Toolkit. Enables LLMs to create chronicles, record events, and query time-ordered data.