netstorage

Documentation

Index

• func DeleteSeries(at *auth.Token, sq *storage.SearchQuery, deadline searchutils.Deadline) (int, error)
• func ExportBlocks(at *auth.Token, sq *storage.SearchQuery, deadline searchutils.Deadline, ...) (bool, error)
• func GetLabelEntries(at *auth.Token, deadline searchutils.Deadline) ([]storage.TagEntry, bool, error)
• func GetLabelValues(at *auth.Token, labelName string, deadline searchutils.Deadline) ([]string, bool, error)
• func GetLabels(at *auth.Token, deadline searchutils.Deadline) ([]string, bool, error)
• func GetSeriesCount(at *auth.Token, deadline searchutils.Deadline) (uint64, bool, error)
• func GetTSDBStatusForDate(at *auth.Token, deadline searchutils.Deadline, date uint64, topN int) (*storage.TSDBStatus, bool, error)
• func GetTagValueSuffixes(at *auth.Token, tr storage.TimeRange, tagKey, tagValuePrefix string, ...) ([]string, bool, error)
• func InitStorageNodes(addrs []string)
• func InitTmpBlocksDir(tmpDirPath string)
• func Stop()
• type Result
• type Results
  • func ProcessSearchQuery(at *auth.Token, sq *storage.SearchQuery, fetchData bool, ...) (*Results, bool, error)
  • func (rss *Results) Cancel()
  • func (rss *Results) Len() int
  • func (rss *Results) RunParallel(f func(rs *Result, workerID uint) error) error

Functions

func DeleteSeries

func DeleteSeries(at *auth.Token, sq *storage.SearchQuery, deadline searchutils.Deadline) (int, error)

DeleteSeries deletes time series matching the given sq.

func ExportBlocks

func ExportBlocks(at *auth.Token, sq *storage.SearchQuery, deadline searchutils.Deadline, f func(mn *storage.MetricName, b *storage.Block, tr storage.TimeRange) error) (bool, error)

ExportBlocks searches for time series matching sq and calls f for each found block.

f is called in parallel from multiple goroutines. Data processing is immediately stopped if f returns non-nil error. It is the responsibility of f to call b.UnmarshalData before reading timestamps and values from the block. It is the responsibility of f to filter blocks according to the given tr.

func GetLabelEntries

func GetLabelEntries(at *auth.Token, deadline searchutils.Deadline) ([]storage.TagEntry, bool, error)

GetLabelEntries returns all the label entries for at until the given deadline.

func GetLabelValues

func GetLabelValues(at *auth.Token, labelName string, deadline searchutils.Deadline) ([]string, bool, error)

GetLabelValues returns label values for the given labelName until the given deadline.

func GetLabels

func GetLabels(at *auth.Token, deadline searchutils.Deadline) ([]string, bool, error)

GetLabels returns labels until the given deadline.

func GetSeriesCount

func GetSeriesCount(at *auth.Token, deadline searchutils.Deadline) (uint64, bool, error)

GetSeriesCount returns the number of unique series for the given at.

func GetTSDBStatusForDate

func GetTSDBStatusForDate(at *auth.Token, deadline searchutils.Deadline, date uint64, topN int) (*storage.TSDBStatus, bool, error)

GetTSDBStatusForDate returns tsdb status according to https://prometheus.io/docs/prometheus/latest/querying/api/#tsdb-stats

func GetTagValueSuffixes

func GetTagValueSuffixes(at *auth.Token, tr storage.TimeRange, tagKey, tagValuePrefix string, delimiter byte, deadline searchutils.Deadline) ([]string, bool, error)

GetTagValueSuffixes returns tag value suffixes for the given tagKey and the given tagValuePrefix.

It can be used for implementing https://graphite-api.readthedocs.io/en/latest/api.html#metrics-find

func InitStorageNodes

func InitStorageNodes(addrs []string)

InitStorageNodes initializes storage nodes' connections to the given addrs.

func InitTmpBlocksDir

func InitTmpBlocksDir(tmpDirPath string)

InitTmpBlocksDir initializes directory to store temporary search results.

It stores data in system-defined temporary directory if tmpDirPath is empty.

func Stop

func Stop()

Stop gracefully stops netstorage.

Types

type Result

type Result struct {
	// The name of the metric.
	MetricName storage.MetricName

	// Values are sorted by Timestamps.
	Values     []float64
	Timestamps []int64

	// Marshaled MetricName. Used only for results sorting
	// in app/vmselect/promql
	MetricNameMarshaled []byte
}

Result is a single timeseries result.

ProcessSearchQuery returns Result slice.

type Results

type Results struct {
	// contains filtered or unexported fields
}

Results holds results returned from ProcessSearchQuery.

func ProcessSearchQuery

func ProcessSearchQuery(at *auth.Token, sq *storage.SearchQuery, fetchData bool, deadline searchutils.Deadline) (*Results, bool, error)

ProcessSearchQuery performs sq until the given deadline.

Results.RunParallel or Results.Cancel must be called on the returned Results.

func (*Results) Cancel

func (rss *Results) Cancel()

Cancel cancels rss work.

func (*Results) Len

func (rss *Results) Len() int

Len returns the number of results in rss.

func (*Results) RunParallel

func (rss *Results) RunParallel(f func(rs *Result, workerID uint) error) error

RunParallel runs f in parallel for all the results from rss.

f shouldn't hold references to rs after returning. workerID is the id of the worker goroutine that calls f. Data processing is immediately stopped if f returns non-nil error.

rss becomes unusable after the call to RunParallel.