tsink 0.10.2

A lightweight embedded time-series database with a straightforward API
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113

//! Shared engine test scaffolding and contributor guardrails.
//!
//! Prefer the smallest fixture that can expose the invariant under test:
//! - pure ingest or in-memory behavior should avoid a data path entirely
//! - persistence and recovery tests should reuse the persistent storage helpers
//! - rollup and dual-lane tests should opt into both lanes explicitly instead of
//!   open-coding a larger `ChunkStorageOptions` block
//!
//! CI mirrors these boundaries with focused `cargo test --lib engine::tests::...`
//! filters in `.github/workflows/ci.yml`. When a refactor changes an engine
//! invariant, tighten the narrowest affected suite before broadening an
//! end-to-end fixture.
//!
//! `src/engine/tests/mod.rs` is the shared test prelude and suite registry.
//! Reusable storage-shape fixtures live under `src/engine/tests/fixtures/`.

pub(super) use std::collections::HashMap;
pub(super) use std::path::Path;
pub(super) use std::sync::Arc;
pub(super) use std::time::Duration;

pub(super) use tempfile::TempDir;

pub(super) use super::bootstrap::merge_loaded_segment_indexes;
pub(super) use super::{
    ChunkStorage, ChunkStorageOptions, BLOB_LANE_ROOT, DEFAULT_ADMISSION_POLL_INTERVAL,
    DEFAULT_COMPACTION_INTERVAL, NUMERIC_LANE_ROOT, SERIES_INDEX_FILE_NAME, WAL_DIR_NAME,
};
pub(super) use crate::engine::chunk::{
    Chunk, ChunkHeader, ChunkPoint, TimestampCodecId, ValueCodecId, ValueLane,
};
pub(super) use crate::engine::encoder::Encoder;
pub(super) use crate::engine::segment::{
    load_segment_index, load_segment_indexes, load_segments_for_level, SegmentWriter,
    WalHighWatermark,
};
pub(super) use crate::engine::series::{SeriesRegistry, SeriesValueFamily};
pub(super) use crate::engine::wal::{
    FramedWal, ReplayFrame, SamplesBatchFrame, SeriesDefinitionFrame,
};
pub(super) use crate::wal::{WalReplayMode, WalSyncMode};
pub(super) use crate::{
    DataPoint, Label, MetricSeries, RemoteSegmentCachePolicy, Row, SeriesMatcher, SeriesPoints,
    SeriesSelection, Storage, StorageBuilder, StorageRuntimeMode, TimestampPrecision, TsinkError,
    Value,
};

#[path = "fixtures/mod.rs"]
mod fixtures;

pub(in crate::engine::storage_engine::tests) use self::fixtures::{
    base_storage_test_options, builder_at_time, default_future_skew_window,
    live_numeric_storage_with_config, make_persisted_numeric_chunk,
    open_raw_numeric_storage_from_data_path,
    open_raw_numeric_storage_from_data_path_with_background_fail_fast,
    open_raw_numeric_storage_with_registry_snapshot_from_data_path, persistent_numeric_storage,
    persistent_numeric_storage_with_metadata_shards, persistent_rollup_storage,
    reopen_persistent_numeric_storage, reopen_persistent_rollup_storage,
};

mod admission_control;
mod capacity;
mod deletion;
mod failure_modes;
mod ingest_concurrency;
mod ingest_core;
mod ingest_failures;
mod persistence_background;
mod persistence_recovery;
mod persistence_segments;
mod reliability;
mod retention_policy;
mod rollups;
mod series_selection;

pub(crate) fn assert_engine_memory_usage_reconciled(storage: &ChunkStorage) {
    if !storage.memory.accounting_enabled {
        return;
    }

    let incremental = storage.memory_observability_snapshot();
    let reconciled_total = storage.refresh_memory_usage();
    let reconciled = storage.memory_observability_snapshot();

    assert_eq!(
        incremental.budgeted_bytes, reconciled_total,
        "incremental engine memory accounting drifted from a full recompute: incremental={incremental:?} reconciled={reconciled:?}",
    );
    assert_eq!(incremental.budgeted_bytes, reconciled.budgeted_bytes);
    assert_eq!(incremental.excluded_bytes, reconciled.excluded_bytes);
    assert_eq!(
        incremental.active_and_sealed_bytes,
        reconciled.active_and_sealed_bytes
    );
    assert_eq!(incremental.registry_bytes, reconciled.registry_bytes);
    assert_eq!(
        incremental.metadata_cache_bytes,
        reconciled.metadata_cache_bytes
    );
    assert_eq!(
        incremental.persisted_index_bytes,
        reconciled.persisted_index_bytes
    );
    assert_eq!(
        incremental.persisted_mmap_bytes,
        reconciled.persisted_mmap_bytes
    );
    assert_eq!(incremental.tombstone_bytes, reconciled.tombstone_bytes);
    assert_eq!(
        incremental.excluded_persisted_mmap_bytes,
        reconciled.excluded_persisted_mmap_bytes
    );
}