vmstorage

README

vmstorage performs the following tasks:

• Accepts inserts from vminsert and stores them to local storage.

• Performs select requests from vmselect.

Documentation

Index

• Variables
• func AddRows(mrs []storage.MetricRow) error
• func CheckTimeRange(tr storage.TimeRange) error
• func DeleteMetrics(tfss []*storage.TagFilters) (int, error)
• func GetSeriesCount(deadline uint64) (uint64, error)
• func GetTSDBStatusForDate(date uint64, topN, maxMetrics int, deadline uint64) (*storage.TSDBStatus, error)
• func GetTSDBStatusWithFiltersForDate(tfss []*storage.TagFilters, date uint64, topN, maxMetrics int, deadline uint64) (*storage.TSDBStatus, error)
• func Init(resetCacheIfNeeded func(mrs []storage.MetricRow))
• func InitWithoutMetrics(resetCacheIfNeeded func(mrs []storage.MetricRow))
• func RegisterMetricNames(mrs []storage.MetricRow) error
• func RequestHandler(w http.ResponseWriter, r *http.Request) bool
• func SearchGraphitePaths(tr storage.TimeRange, query []byte, maxPaths int, deadline uint64) ([]string, error)
• func SearchMetricNames(tfss []*storage.TagFilters, tr storage.TimeRange, maxMetrics int, ...) ([]storage.MetricName, error)
• func SearchTagEntries(maxTagKeys, maxTagValues int, deadline uint64) ([]storage.TagEntry, error)
• func SearchTagKeys(maxTagKeys int, deadline uint64) ([]string, error)
• func SearchTagKeysOnTimeRange(tr storage.TimeRange, maxTagKeys int, deadline uint64) ([]string, error)
• func SearchTagValueSuffixes(tr storage.TimeRange, tagKey, tagValuePrefix []byte, delimiter byte, ...) ([]string, error)
• func SearchTagValues(tagKey []byte, maxTagValues int, deadline uint64) ([]string, error)
• func SearchTagValuesOnTimeRange(tagKey []byte, tr storage.TimeRange, maxTagValues int, deadline uint64) ([]string, error)
• func Stop()

Variables

var (

	// DataPath is a path to storage data.
	DataPath = flag.String("storageDataPath", "victoria-metrics-data", "Path to storage data")
)

var Storage *storage.Storage

Storage is a storage.

Every storage call must be wrapped into WG.Add(1) ... WG.Done() for proper graceful shutdown when Stop is called.

var WG syncwg.WaitGroup

WG must be incremented before Storage call.

Use syncwg instead of sync, since Add is called from concurrent goroutines.

Functions

func AddRows

func AddRows(mrs []storage.MetricRow) error

AddRows adds mrs to the storage.

func CheckTimeRange

func CheckTimeRange(tr storage.TimeRange) error

CheckTimeRange returns true if the given tr is denied for querying.

func DeleteMetrics

func DeleteMetrics(tfss []*storage.TagFilters) (int, error)

DeleteMetrics deletes metrics matching tfss.

Returns the number of deleted metrics.

func GetSeriesCount

func GetSeriesCount(deadline uint64) (uint64, error)

GetSeriesCount returns the number of time series in the storage.

func GetTSDBStatusForDate

func GetTSDBStatusForDate(date uint64, topN, maxMetrics int, deadline uint64) (*storage.TSDBStatus, error)

GetTSDBStatusForDate returns TSDB status for the given date.

func GetTSDBStatusWithFiltersForDate

func GetTSDBStatusWithFiltersForDate(tfss []*storage.TagFilters, date uint64, topN, maxMetrics int, deadline uint64) (*storage.TSDBStatus, error)

GetTSDBStatusWithFiltersForDate returns TSDB status for given filters on the given date.

func Init

func Init(resetCacheIfNeeded func(mrs []storage.MetricRow))

Init initializes vmstorage.

func InitWithoutMetrics

func InitWithoutMetrics(resetCacheIfNeeded func(mrs []storage.MetricRow))

InitWithoutMetrics must be called instead of Init inside tests.

This allows multiple Init / Stop cycles.

func RegisterMetricNames

func RegisterMetricNames(mrs []storage.MetricRow) error

RegisterMetricNames registers all the metrics from mrs in the storage.

func RequestHandler

func RequestHandler(w http.ResponseWriter, r *http.Request) bool

RequestHandler is a storage request handler.

func SearchGraphitePaths

func SearchGraphitePaths(tr storage.TimeRange, query []byte, maxPaths int, deadline uint64) ([]string, error)

SearchGraphitePaths returns all the metric names matching the given Graphite query.

func SearchMetricNames

func SearchMetricNames(tfss []*storage.TagFilters, tr storage.TimeRange, maxMetrics int, deadline uint64) ([]storage.MetricName, error)

SearchMetricNames returns metric names for the given tfss on the given tr.

func SearchTagEntries

func SearchTagEntries(maxTagKeys, maxTagValues int, deadline uint64) ([]storage.TagEntry, error)

SearchTagEntries searches for tag entries.

func SearchTagKeys

func SearchTagKeys(maxTagKeys int, deadline uint64) ([]string, error)

SearchTagKeys searches for tag keys

func SearchTagKeysOnTimeRange

func SearchTagKeysOnTimeRange(tr storage.TimeRange, maxTagKeys int, deadline uint64) ([]string, error)

SearchTagKeysOnTimeRange searches for tag keys on tr.

func SearchTagValueSuffixes

func SearchTagValueSuffixes(tr storage.TimeRange, tagKey, tagValuePrefix []byte, delimiter byte, maxTagValueSuffixes int, deadline uint64) ([]string, error)

SearchTagValueSuffixes returns all the tag value suffixes for the given tagKey and tagValuePrefix on the given tr.

This allows implementing https://graphite-api.readthedocs.io/en/latest/api.html#metrics-find or similar APIs.

func SearchTagValues

func SearchTagValues(tagKey []byte, maxTagValues int, deadline uint64) ([]string, error)

SearchTagValues searches for tag values for the given tagKey

func SearchTagValuesOnTimeRange

func SearchTagValuesOnTimeRange(tagKey []byte, tr storage.TimeRange, maxTagValues int, deadline uint64) ([]string, error)

SearchTagValuesOnTimeRange searches for tag values for the given tagKey on tr.

func Stop

func Stop()

Stop stops the vmstorage