victoriaMetrics庫之布隆過濾器

victoriaMetrics庫之布隆過濾器

代碼路徑：/lib/bloomfilter

概述

victoriaMetrics的vmstorage組件會接收上游傳遞過來的指標，在現實場景中，指標或瞬時指標的數量級可能會非常恐怖，如果不限制緩存的大小，有可能會由於cache miss而導致出現過高的slow insert。

爲此，vmstorage提供了兩個參數：maxHourlySeries和maxDailySeries，用於限制每小時/每天添加到緩存的唯一序列。

唯一序列指表示唯一的時間序列，如metrics{label1="value1",label2="value2"}屬於一個時間序列，但多條不同值的metrics{label1="value1",label2="value2"}屬於同一條時間序列。victoriaMetrics使用如下方式來獲取時序的唯一標識：

func getLabelsHash(labels []prompbmarshal.Label) uint64 {
	bb := labelsHashBufPool.Get()
	b := bb.B[:0]
	for _, label := range labels {
		b = append(b, label.Name...)
		b = append(b, label.Value...)
	}
	h := xxhash.Sum64(b)
	bb.B = b
	labelsHashBufPool.Put(bb)
	return h
}

限速器的初始化

victoriaMetrics使用了一個類似限速器的概念，限制每小時/每天新增的唯一序列，但與普通的限速器不同的是，它需要在序列級別進行限制，即判斷某個序列是否是新的唯一序列，如果是，則需要進一步判斷一段時間內緩存中新的時序數目是否超過限制，而不是簡單地在請求層面進行限制。

hourlySeriesLimiter = bloomfilter.NewLimiter(*maxHourlySeries, time.Hour)
dailySeriesLimiter = bloomfilter.NewLimiter(*maxDailySeries, 24*time.Hour)

下面是新建限速器的函數，傳入一個最大(序列)值，以及一個刷新時間。該函數中會：

1. 初始化一個限速器，限速器的最大元素個數爲maxItems
2. 則啓用了一個goroutine，當時間達到refreshInterval時會重置限速器

func NewLimiter(maxItems int, refreshInterval time.Duration) *Limiter {
	l := &Limiter{
		maxItems: maxItems,
		stopCh:   make(chan struct{}),
	}
	l.v.Store(newLimiter(maxItems)) //1
	l.wg.Add(1)
	go func() {
		defer l.wg.Done()
		t := time.NewTicker(refreshInterval)
		defer t.Stop()
		for {
			select {
			case <-t.C:
				l.v.Store(newLimiter(maxItems))//2
			case <-l.stopCh:
				return
			}
		}
	}()
	return l
}

限速器只有一個核心函數Add，當vmstorage接收到一個指標之後，會(通過getLabelsHash計算該指標的唯一標識(h)，然後調用下面的Add函數來判斷該唯一標識是否存在於緩存中。

如果當前存儲的元素個數大於等於允許的最大元素，則通過過濾器判斷緩存中是否已經存在該元素；否則將該元素直接加入過濾器中，後續允許將該元素加入到緩存中。

func (l *Limiter) Add(h uint64) bool {
	lm := l.v.Load().(*limiter)
	return lm.Add(h)
}

func (l *limiter) Add(h uint64) bool {
	currentItems := atomic.LoadUint64(&l.currentItems)
	if currentItems >= uint64(l.f.maxItems) {
		return l.f.Has(h)
	}
	if l.f.Add(h) {
		atomic.AddUint64(&l.currentItems, 1)
	}
	return true
}

上面的過濾器採用的是布隆過濾器，核心函數爲Has和Add，分別用於判斷某個元素是否存在於過濾器中，以及將元素添加到布隆過濾器中。

過濾器的初始化函數如下，bitsPerItem是個常量，值爲16。bitsCount統計了過濾器中的總bit數，每個bit表示某個值的存在性。bits以64bit爲單位的(後續稱之爲slot，目的是爲了在bitsCount中快速檢索目標bit)。計算bits時加上63的原因是爲了四捨五入向上取值，比如當maxItems=1時至少需要1個unit64的slot。

func newFilter(maxItems int) *filter {
	bitsCount := maxItems * bitsPerItem
	bits := make([]uint64, (bitsCount+63)/64)
	return &filter{
		maxItems: maxItems,
		bits:     bits,
	}
}

爲什麼bitsPerItem爲16？這篇文章給出瞭如何計算布隆過濾器的大小。在本代碼中，k爲4(hashesCount)，期望的漏失率爲0.003(可以從官方的filter_test.go中看出)，則要求總存儲和總元素的比例爲15，爲了方便檢索slot(64bit，爲16的倍數)，將之設置爲16。

	if p > 0.003 {
		t.Fatalf("too big false hits share for maxItems=%d: %.5f, falseHits: %d", maxItems, p, falseHits)
	}

下面是過濾器的Add操作，目的是在過濾器中添加某個元素。Add函數中沒有使用多個哈希函數來計算元素的哈希值，轉而改變同一個元素的值，然後對相應的值應用相同的哈希函數，元素改變的次數受hashesCount的限制。

1. 獲取過濾器的完整存儲，並轉換爲以bit單位
2. 將元素h轉換爲byte數組，便於xxhash.Sum64計算
3. 後續將執行hashesCount次哈希，降低漏失率
4. 計算元素h的哈希
5. 遞增元素h，爲下一次哈希做準備
6. 取餘法獲取元素的bit範圍
7. 獲取元素所在的slot(即uint64大小的bit範圍)
8. 獲取元素所在的slot中的bit位，該位爲1表示該元素存在，爲0表示該元素不存在
9. 獲取元素所在bit位的掩碼
10. 加載元素所在的slot的數值
11. 如果w & mask結果爲0，說明該元素不存在，
12. 將元素所在的slot(w)中的元素所在的bit位(mask)置爲1，表示添加了該元素
13. 由於Add函數可以併發訪問，因此bits[i]有可能被其他操作修改，因此需要通過重新加載(14)並通過循環來在bits[i]中設置該元素的存在性

func (f *filter) Add(h uint64) bool {
	bits := f.bits
	maxBits := uint64(len(bits)) * 64 //1
	bp := (*[8]byte)(unsafe.Pointer(&h))//2
	b := bp[:]
	isNew := false
	for i := 0; i < hashesCount; i++ {//3
		hi := xxhash.Sum64(b)//4
		h++ //5
		idx := hi % maxBits //6
		i := idx / 64 //7
		j := idx % 64 //8
		mask := uint64(1) << j //9
		w := atomic.LoadUint64(&bits[i])//10
		for (w & mask) == 0 {//11
			wNew := w | mask //12
			if atomic.CompareAndSwapUint64(&bits[i], w, wNew) {//13
				isNew = true//14
				break
			}
			w = atomic.LoadUint64(&bits[i])//14
		}
	}
	return isNew
}

看懂了Add函數，Has就相當簡單了，它只是Add函數的縮減版，無需設置bits[i]：

func (f *filter) Has(h uint64) bool {
	bits := f.bits
	maxBits := uint64(len(bits)) * 64
	bp := (*[8]byte)(unsafe.Pointer(&h))
	b := bp[:]
	for i := 0; i < hashesCount; i++ {
		hi := xxhash.Sum64(b)
		h++
		idx := hi % maxBits
		i := idx / 64
		j := idx % 64
		mask := uint64(1) << j
		w := atomic.LoadUint64(&bits[i])
		if (w & mask) == 0 {
			return false
		}
	}
	return true
}

總結

由於victoriaMetrics的過濾器採用的是布隆過濾器，因此它的限速並不精準，在源碼條件下， 大約有3%的偏差。但同樣地，由於採用了布隆過濾器，降低了所需的內存以及相關計算資源。此外victoriaMetrics的過濾器實現了併發訪問。

在大流量場景中，如果需要對請求進行相對精準的過濾，可以考慮使用布隆過濾器，降低所需要的資源，但前提是過濾的結果能夠忍受一定程度的漏失率。