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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
use std::collections::{BTreeMap, BTreeSet, HashMap, HashSet};
use std::sync::atomic::Ordering;

use super::*;
use crate::validation::{canonicalize_labels, validate_metric};
use crate::{Label, Result, Row, TsinkError};

impl SeriesRegistry {
    pub(super) fn series_definitions(&self) -> Vec<SeriesDefinition> {
        let mut definitions = Vec::new();
        for shard in &self.series_shards {
            definitions.extend(shard.read().by_id.values().cloned());
        }
        definitions
    }

    pub(super) fn series_definitions_with_families(
        &self,
    ) -> Vec<(SeriesDefinition, Option<SeriesValueFamily>)> {
        let mut definitions = Vec::new();
        for shard in &self.series_shards {
            let shard = shard.read();
            definitions.extend(shard.by_id.values().cloned().map(|definition| {
                let family = shard.value_families.get(&definition.series_id).copied();
                (definition, family)
            }));
        }
        definitions
    }

    fn alloc_series_id(&self) -> Result<SeriesId> {
        let mut current = self.next_series_id.load(Ordering::Acquire).max(1);
        loop {
            let next = current.checked_add(1).ok_or_else(|| {
                TsinkError::InvalidConfiguration(
                    "series id space exhausted (u64 overflow)".to_string(),
                )
            })?;
            match self.next_series_id.compare_exchange(
                current,
                next,
                Ordering::AcqRel,
                Ordering::Acquire,
            ) {
                Ok(_) => return Ok(current),
                Err(observed) => current = observed.max(1),
            }
        }
    }

    pub(crate) fn estimate_new_series_memory_growth_bytes(
        &self,
        series: &[SeriesKey],
    ) -> Result<usize> {
        if series.is_empty() {
            return Ok(0);
        }

        #[derive(Debug)]
        struct EstimatedNewSeries {
            series_id: SeriesId,
            metric_id: DictionaryId,
            label_pairs: Vec<LabelPairId>,
            present_label_names: BTreeSet<DictionaryId>,
        }

        let metric_dict = self.metric_dict.read();
        let label_name_dict = self.label_name_dict.read();
        let label_value_dict = self.label_value_dict.read();

        let mut pending_metric_ids = HashMap::<String, DictionaryId>::new();
        let mut pending_label_name_ids = HashMap::<String, DictionaryId>::new();
        let mut pending_label_value_ids = HashMap::<String, DictionaryId>::new();
        let mut next_metric_len = metric_dict.len();
        let mut next_label_name_len = label_name_dict.len();
        let mut next_label_value_len = label_value_dict.len();
        let mut predicted_next_series_id = self.next_series_id_value();
        let mut planned_keys = HashSet::<SeriesKeyIds>::new();
        let mut estimated_dictionary_bytes = 0usize;
        let mut estimated_series_bytes = 0usize;
        let mut estimated_series = Vec::<EstimatedNewSeries>::new();

        for key in series {
            validate_metric(&key.metric)?;

            let (metric_id, metric_bytes) = Self::estimate_string_dictionary_entry(
                &metric_dict,
                &mut pending_metric_ids,
                &mut next_metric_len,
                &key.metric,
                "metric",
            )?;
            estimated_dictionary_bytes = estimated_dictionary_bytes.saturating_add(metric_bytes);

            let normalized_labels = canonicalize_labels(&key.labels)?;

            let mut label_pairs = Vec::with_capacity(normalized_labels.len());
            let mut present_label_names = BTreeSet::new();
            for label in &normalized_labels {
                let (name_id, name_bytes) = Self::estimate_string_dictionary_entry(
                    &label_name_dict,
                    &mut pending_label_name_ids,
                    &mut next_label_name_len,
                    &label.name,
                    "label name",
                )?;
                estimated_dictionary_bytes = estimated_dictionary_bytes.saturating_add(name_bytes);

                let (value_id, value_bytes) = Self::estimate_string_dictionary_entry(
                    &label_value_dict,
                    &mut pending_label_value_ids,
                    &mut next_label_value_len,
                    &label.value,
                    "label value",
                )?;
                estimated_dictionary_bytes = estimated_dictionary_bytes.saturating_add(value_bytes);

                label_pairs.push(LabelPairId { name_id, value_id });
                present_label_names.insert(name_id);
            }
            label_pairs.sort_unstable();

            let key_ids = SeriesKeyIds {
                metric_id,
                label_pairs: label_pairs.clone(),
            };
            let shard_idx = Self::key_shard_idx_for_key(&key_ids);
            if self.series_shards[shard_idx]
                .read()
                .by_key
                .contains_key(&key_ids)
            {
                continue;
            }
            if !planned_keys.insert(key_ids) {
                continue;
            }

            let series_id = predicted_next_series_id;
            predicted_next_series_id =
                predicted_next_series_id.checked_add(1).ok_or_else(|| {
                    TsinkError::InvalidConfiguration(
                        "series id space exhausted (u64 overflow)".to_string(),
                    )
                })?;
            estimated_series_bytes = estimated_series_bytes
                .saturating_add(Self::series_label_pairs_memory_bytes(&label_pairs));
            estimated_series.push(EstimatedNewSeries {
                series_id,
                metric_id,
                label_pairs,
                present_label_names,
            });
        }

        drop(label_value_dict);
        drop(label_name_dict);
        drop(metric_dict);

        let mut estimated_bytes = estimated_dictionary_bytes.saturating_add(estimated_series_bytes);
        if estimated_series.is_empty() {
            return Ok(estimated_bytes);
        }
        let mut all_series_inserts = BTreeMap::<usize, Vec<SeriesId>>::new();
        let mut metric_inserts = BTreeMap::<DictionaryId, Vec<SeriesId>>::new();
        let mut label_name_inserts = BTreeMap::<DictionaryId, Vec<SeriesId>>::new();
        let mut pair_inserts = BTreeMap::<LabelPairId, Vec<SeriesId>>::new();

        for series in &estimated_series {
            all_series_inserts
                .entry(Self::all_series_shard_idx(series.series_id))
                .or_default()
                .push(series.series_id);
            metric_inserts
                .entry(series.metric_id)
                .or_default()
                .push(series.series_id);
            for name_id in &series.present_label_names {
                label_name_inserts
                    .entry(*name_id)
                    .or_default()
                    .push(series.series_id);
            }
            for pair in &series.label_pairs {
                pair_inserts
                    .entry(*pair)
                    .or_default()
                    .push(series.series_id);
            }
        }

        for (shard_idx, series_ids) in all_series_inserts {
            let mut updated = self.all_series_shards[shard_idx].read().series_ids.clone();
            let before = Self::bitmap_memory_usage_bytes(&updated);
            for series_id in series_ids {
                updated.insert(series_id);
            }
            estimated_bytes = estimated_bytes
                .saturating_add(Self::bitmap_memory_usage_bytes(&updated).saturating_sub(before));
        }

        for (metric_id, series_ids) in metric_inserts {
            let shard_idx = Self::metric_postings_shard_idx(metric_id);
            let mut updated = self.metric_postings_shards[shard_idx]
                .read()
                .metric_postings
                .get(&metric_id)
                .cloned()
                .unwrap_or_default();
            let before = Self::bitmap_memory_usage_bytes(&updated);
            for series_id in series_ids {
                updated.insert(series_id);
            }
            estimated_bytes = estimated_bytes
                .saturating_add(Self::bitmap_memory_usage_bytes(&updated).saturating_sub(before));
        }

        for (name_id, series_ids) in label_name_inserts {
            let shard_idx = Self::label_postings_shard_idx(name_id);
            let mut updated = self.label_postings_shards[shard_idx]
                .read()
                .label_name_states
                .get(&name_id)
                .map(|state| state.present.clone())
                .unwrap_or_default();
            let before = Self::bitmap_memory_usage_bytes(&updated);
            for series_id in series_ids {
                updated.insert(series_id);
            }
            estimated_bytes = estimated_bytes
                .saturating_add(Self::bitmap_memory_usage_bytes(&updated).saturating_sub(before));
        }

        let mut created_count_entries = BTreeSet::new();
        for (pair, series_ids) in pair_inserts {
            let shard_idx = Self::label_postings_shard_idx(pair.name_id);
            let shard = self.label_postings_shards[shard_idx].read();
            let mut updated = shard.postings.get(&pair).cloned().unwrap_or_default();
            let before = Self::bitmap_memory_usage_bytes(&updated);
            for series_id in series_ids {
                updated.insert(series_id);
            }
            estimated_bytes = estimated_bytes
                .saturating_add(Self::bitmap_memory_usage_bytes(&updated).saturating_sub(before));
            if !shard.postings.contains_key(&pair)
                && shard
                    .label_name_states
                    .get(&pair.name_id)
                    .map(|state| state.bucket_count)
                    .unwrap_or(0)
                    == 0
                && created_count_entries.insert(pair.name_id)
            {
                estimated_bytes =
                    estimated_bytes.saturating_add(Self::label_name_postings_count_entry_bytes());
            }
        }

        Ok(estimated_bytes)
    }

    pub fn resolve_or_insert(&self, metric: &str, labels: &[Label]) -> Result<SeriesResolution> {
        validate_metric(metric)?;
        let normalized_labels = canonicalize_labels(labels)?;

        let metric_id = self.intern_metric_id(metric)?;
        let label_pairs = self.intern_label_pairs(&normalized_labels)?;
        let key = SeriesKeyIds {
            metric_id,
            label_pairs: label_pairs.clone(),
        };
        let shard_idx = Self::key_shard_idx_for_key(&key);
        let mut shard = self.series_shards[shard_idx].write();

        if let Some(existing) = shard.by_key.get(&key) {
            return Ok(SeriesResolution {
                series_id: *existing,
                metric_id,
                label_pairs,
                created: false,
            });
        }

        let series_id = self.alloc_series_id()?;
        shard.by_id.insert(
            series_id,
            SeriesDefinition {
                series_id,
                metric_id,
                label_pairs: label_pairs.clone(),
            },
        );
        let added_series_bytes = Self::series_label_pairs_memory_bytes(&label_pairs);
        shard.estimated_series_bytes = shard
            .estimated_series_bytes
            .saturating_add(added_series_bytes);
        self.series_id_shards[Self::series_id_index_shard_idx(series_id)]
            .write()
            .series_id_to_registry_shard
            .insert(series_id, shard_idx);
        self.index_series_locked(metric_id, series_id, &label_pairs);
        shard.by_key.insert(key, series_id);
        self.series_count.fetch_add(1, Ordering::AcqRel);
        self.add_estimated_memory_bytes(added_series_bytes);
        self.bump_postings_generation();

        Ok(SeriesResolution {
            series_id,
            metric_id,
            label_pairs,
            created: true,
        })
    }

    pub fn resolve_existing(&self, metric: &str, labels: &[Label]) -> Option<SeriesResolution> {
        validate_metric(metric).ok()?;
        let metric_id = self.metric_dict.read().get_id(metric)?;
        let normalized_labels = canonicalize_labels(labels).ok()?;
        let label_pairs = self.lookup_label_pairs(&normalized_labels)?;
        let key = SeriesKeyIds {
            metric_id,
            label_pairs: label_pairs.clone(),
        };
        let shard_idx = Self::key_shard_idx_for_key(&key);
        let series_id = *self.series_shards[shard_idx].read().by_key.get(&key)?;
        Some(SeriesResolution {
            series_id,
            metric_id,
            label_pairs,
            created: false,
        })
    }

    pub fn resolve_rows(&self, rows: &[Row]) -> Result<Vec<SeriesResolution>> {
        let planned_series = rows
            .iter()
            .map(|row| SeriesKey {
                metric: row.metric().to_string(),
                labels: row.labels().to_vec(),
            })
            .collect::<Vec<_>>();
        self.prime_dictionaries_for_series(&planned_series)?;
        let mut resolutions = Vec::with_capacity(rows.len());
        for row in rows {
            resolutions.push(self.resolve_or_insert(row.metric(), row.labels())?);
        }
        Ok(resolutions)
    }

    pub fn reserve_new_series_capacity(&self, limit: usize, requested: usize) -> Result<()> {
        if limit == usize::MAX || requested == 0 {
            return Ok(());
        }

        let mut pending = self.pending_series_reservations.load(Ordering::Acquire);
        loop {
            let current = self.series_count();
            if current.saturating_add(pending).saturating_add(requested) > limit {
                return Err(TsinkError::CardinalityLimitExceeded {
                    limit,
                    current: current.saturating_add(pending),
                    requested,
                });
            }
            match self.pending_series_reservations.compare_exchange(
                pending,
                pending.saturating_add(requested),
                Ordering::AcqRel,
                Ordering::Acquire,
            ) {
                Ok(_) => return Ok(()),
                Err(observed) => pending = observed,
            }
        }
    }

    pub fn release_new_series_capacity(&self, released: usize) {
        if released == 0 {
            return;
        }
        self.pending_series_reservations
            .fetch_sub(released, Ordering::AcqRel);
    }

    pub(crate) fn rollback_created_series(&self, created: &[SeriesResolution]) {
        if created.is_empty() {
            return;
        }

        let mut removed_any = false;
        for resolution in created {
            let key = SeriesKeyIds {
                metric_id: resolution.metric_id,
                label_pairs: resolution.label_pairs.clone(),
            };
            let shard_idx = Self::key_shard_idx_for_key(&key);
            let mut shard = self.series_shards[shard_idx].write();
            if shard.by_key.remove(&key).is_none() {
                continue;
            }
            if shard.value_families.remove(&resolution.series_id).is_some() {
                self.sub_estimated_memory_bytes(Self::value_family_entry_bytes());
                shard.estimated_series_bytes = shard
                    .estimated_series_bytes
                    .saturating_sub(Self::value_family_entry_bytes());
            }
            if shard.by_id.remove(&resolution.series_id).is_some() {
                let removed_series_bytes =
                    Self::series_label_pairs_memory_bytes(&resolution.label_pairs);
                shard.estimated_series_bytes = shard
                    .estimated_series_bytes
                    .saturating_sub(removed_series_bytes);
                self.remove_series_from_indexes_locked(
                    resolution.metric_id,
                    resolution.series_id,
                    &resolution.label_pairs,
                );
                self.series_id_shards[Self::series_id_index_shard_idx(resolution.series_id)]
                    .write()
                    .series_id_to_registry_shard
                    .remove(&resolution.series_id);
                self.series_count.fetch_sub(1, Ordering::AcqRel);
                self.sub_estimated_memory_bytes(removed_series_bytes);
                removed_any = true;
            }
        }
        if removed_any {
            self.bump_postings_generation();
        }
    }

    pub fn register_series_with_id(
        &self,
        series_id: SeriesId,
        metric: &str,
        labels: &[Label],
    ) -> Result<SeriesResolution> {
        validate_metric(metric)?;
        let normalized_labels = canonicalize_labels(labels)?;

        let metric_id = self.intern_metric_id(metric)?;
        let label_pairs = self.intern_label_pairs(&normalized_labels)?;
        let key = SeriesKeyIds {
            metric_id,
            label_pairs: label_pairs.clone(),
        };
        let shard_idx = Self::key_shard_idx_for_key(&key);
        let mut shard = self.series_shards[shard_idx].write();

        if let Some(existing_id) = shard.by_key.get(&key) {
            if *existing_id != series_id {
                return Err(TsinkError::DataCorruption(format!(
                    "series key already bound to id {}, replay tried to bind {}",
                    existing_id, series_id
                )));
            }
            return Ok(SeriesResolution {
                series_id,
                metric_id,
                label_pairs,
                created: false,
            });
        }

        if let Some(existing) = self.get_by_id(series_id) {
            if existing.metric_id != metric_id || existing.label_pairs != label_pairs {
                return Err(TsinkError::DataCorruption(format!(
                    "series id {} already exists with a different series definition",
                    series_id
                )));
            }
            return Ok(SeriesResolution {
                series_id,
                metric_id,
                label_pairs,
                created: false,
            });
        }

        shard.by_id.insert(
            series_id,
            SeriesDefinition {
                series_id,
                metric_id,
                label_pairs: label_pairs.clone(),
            },
        );
        let added_series_bytes = Self::series_label_pairs_memory_bytes(&label_pairs);
        shard.estimated_series_bytes = shard
            .estimated_series_bytes
            .saturating_add(added_series_bytes);
        self.series_id_shards[Self::series_id_index_shard_idx(series_id)]
            .write()
            .series_id_to_registry_shard
            .insert(series_id, shard_idx);
        self.index_series_locked(metric_id, series_id, &label_pairs);
        shard.by_key.insert(key, series_id);
        self.series_count.fetch_add(1, Ordering::AcqRel);
        self.add_estimated_memory_bytes(added_series_bytes);
        self.reserve_series_id(series_id)?;
        self.bump_postings_generation();

        Ok(SeriesResolution {
            series_id,
            metric_id,
            label_pairs,
            created: true,
        })
    }

    pub fn get_by_id(&self, series_id: SeriesId) -> Option<SeriesDefinition> {
        let shard_idx = self.load_series_registry_shard_idx(series_id)?;
        self.series_shards[shard_idx]
            .read()
            .by_id
            .get(&series_id)
            .cloned()
    }

    pub fn all_series_ids(&self) -> Vec<SeriesId> {
        let mut series_ids = Vec::new();
        self.for_each_series_id(|series_id| series_ids.push(series_id));
        series_ids.sort_unstable();
        series_ids
    }

    pub fn series_count(&self) -> usize {
        self.series_count.load(Ordering::Acquire)
    }

    pub fn is_empty(&self) -> bool {
        self.series_count() == 0
    }

    pub fn reserve_series_id(&self, series_id: SeriesId) -> Result<()> {
        let required_next = series_id.checked_add(1).ok_or_else(|| {
            TsinkError::InvalidConfiguration("series id space exhausted (u64 overflow)".to_string())
        })?;
        let mut current = self.next_series_id.load(Ordering::Acquire).max(1);
        while current < required_next {
            match self.next_series_id.compare_exchange(
                current,
                required_next,
                Ordering::AcqRel,
                Ordering::Acquire,
            ) {
                Ok(_) => return Ok(()),
                Err(observed) => current = observed.max(1),
            }
        }
        Ok(())
    }

    pub fn retain_series_ids(&self, keep: &BTreeSet<SeriesId>) {
        let mut retained_max = 0u64;
        let mut retained_count = 0usize;
        for shard in &self.series_shards {
            let mut shard = shard.write();
            shard.by_id.retain(|series_id, _| keep.contains(series_id));
            shard.by_key.retain(|_, series_id| keep.contains(series_id));
            shard
                .value_families
                .retain(|series_id, _| keep.contains(series_id));
            retained_count = retained_count.saturating_add(shard.by_id.len());
            retained_max = retained_max.max(shard.by_id.keys().copied().max().unwrap_or(0));
            let label_pair_bytes = shard.by_id.values().fold(0usize, |acc, series| {
                acc.saturating_add(Self::series_label_pairs_memory_bytes(&series.label_pairs))
            });
            let value_family_bytes = shard
                .value_families
                .len()
                .saturating_mul(Self::value_family_entry_bytes());
            shard.estimated_series_bytes = label_pair_bytes.saturating_add(value_family_bytes);
        }
        for shard in &self.series_id_shards {
            shard
                .write()
                .series_id_to_registry_shard
                .retain(|series_id, _| keep.contains(series_id));
        }
        self.series_count.store(retained_count, Ordering::Release);
        self.rebuild_postings_indexes();
        if retained_max > 0 {
            let _ = self.reserve_series_id(retained_max);
        }
    }

    pub fn merge_from(&self, other: &SeriesRegistry) -> Result<usize> {
        let mut created = 0usize;
        for series_id in other.all_series_ids() {
            let Some(series_key) = other.decode_series_key(series_id) else {
                continue;
            };
            let resolution =
                self.register_series_with_id(series_id, &series_key.metric, &series_key.labels)?;
            created = created.saturating_add(usize::from(resolution.created));
            if let Some(family) = other.series_value_family(series_id) {
                self.record_series_value_family(series_id, family)?;
            }
        }
        self.reserve_series_id(other.next_series_id_value().saturating_sub(1))?;
        Ok(created)
    }

    pub fn series_subset<I>(&self, series_ids: I) -> Result<Self>
    where
        I: IntoIterator<Item = SeriesId>,
    {
        let subset = Self::new();
        let mut series_ids = series_ids.into_iter().collect::<Vec<_>>();
        if series_ids.is_empty() {
            return Ok(subset);
        }
        series_ids.sort_unstable();
        series_ids.dedup();

        for series_id in series_ids {
            let Some(series_key) = self.decode_series_key(series_id) else {
                continue;
            };
            subset.register_series_with_id(series_id, &series_key.metric, &series_key.labels)?;
            if let Some(family) = self.series_value_family(series_id) {
                subset.record_series_value_family(series_id, family)?;
            }
        }
        subset.reserve_series_id(self.next_series_id_value().saturating_sub(1))?;
        Ok(subset)
    }
}