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
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

use crate::query_matcher::{compile_series_matchers, CompiledSeriesMatcher};
use crate::storage::Storage;
use crate::validation::validate_metric;
use crate::{MetricSeries, Result, SeriesSelection};

pub(crate) struct PreparedSeriesSelection {
    pub(crate) time_range: Option<(i64, i64)>,
    pub(crate) compiled_matchers: Vec<CompiledSeriesMatcher>,
}

pub(crate) trait SeriesSelectionBackend {
    type Candidates;

    fn candidate_items(
        &self,
        selection: &SeriesSelection,
        prepared: &PreparedSeriesSelection,
    ) -> Result<Self::Candidates>;

    fn retain_items_in_time_range(
        &self,
        items: &mut Self::Candidates,
        start: i64,
        end: i64,
    ) -> Result<()>;

    fn materialize_items(&self, items: Self::Candidates) -> Result<Vec<MetricSeries>>;
}

pub(crate) fn validate_series_selection(selection: &SeriesSelection) -> Result<Option<(i64, i64)>> {
    if let Some(metric) = selection.metric.as_deref() {
        validate_metric(metric)?;
    }
    selection.normalized_time_range()
}

pub(crate) fn prepare_series_selection(
    selection: &SeriesSelection,
) -> Result<PreparedSeriesSelection> {
    let time_range = validate_series_selection(selection)?;
    let compiled_matchers = compile_series_matchers(&selection.matchers)?;
    Ok(PreparedSeriesSelection {
        time_range,
        compiled_matchers,
    })
}

fn series_matches_selection(
    entry: &MetricSeries,
    selection: &SeriesSelection,
    prepared: &PreparedSeriesSelection,
) -> bool {
    if selection
        .metric
        .as_ref()
        .is_some_and(|metric| entry.name != *metric)
    {
        return false;
    }

    prepared
        .compiled_matchers
        .iter()
        .all(|matcher| matcher.matches(&entry.name, &entry.labels))
}

fn retain_series_matching_selection(
    series: &mut Vec<MetricSeries>,
    selection: &SeriesSelection,
    prepared: &PreparedSeriesSelection,
) {
    series.retain(|entry| series_matches_selection(entry, selection, prepared));
}

pub(crate) fn execute_series_selection<B: SeriesSelectionBackend>(
    backend: &B,
    selection: &SeriesSelection,
) -> Result<Vec<MetricSeries>> {
    let prepared = prepare_series_selection(selection)?;
    let mut candidates = backend.candidate_items(selection, &prepared)?;

    if let Some((start, end)) = prepared.time_range {
        backend.retain_items_in_time_range(&mut candidates, start, end)?;
    }

    let mut series = backend.materialize_items(candidates)?;
    retain_series_matching_selection(&mut series, selection, &prepared);
    series.sort();
    Ok(series)
}

struct ScanSeriesSelectionBackend<'a, S: Storage + ?Sized> {
    storage: &'a S,
}

impl<S: Storage + ?Sized> SeriesSelectionBackend for ScanSeriesSelectionBackend<'_, S> {
    type Candidates = Vec<MetricSeries>;

    fn candidate_items(
        &self,
        selection: &SeriesSelection,
        prepared: &PreparedSeriesSelection,
    ) -> Result<Self::Candidates> {
        let mut series = self.storage.list_metrics()?;
        retain_series_matching_selection(&mut series, selection, prepared);
        Ok(series)
    }

    fn retain_items_in_time_range(
        &self,
        items: &mut Self::Candidates,
        start: i64,
        end: i64,
    ) -> Result<()> {
        if items.is_empty() {
            return Ok(());
        }

        let mut filtered = Vec::with_capacity(items.len());
        for entry in items.drain(..) {
            let points = self
                .storage
                .select(&entry.name, &entry.labels, start, end)?;
            if !points.is_empty() {
                filtered.push(entry);
            }
        }
        *items = filtered;
        Ok(())
    }

    fn materialize_items(&self, items: Self::Candidates) -> Result<Vec<MetricSeries>> {
        Ok(items)
    }
}

pub(crate) fn select_series_by_scan<S: Storage + ?Sized>(
    storage: &S,
    selection: &SeriesSelection,
) -> Result<Vec<MetricSeries>> {
    execute_series_selection(&ScanSeriesSelectionBackend { storage }, selection)
}