95 lines
4.3 KiB
Go
95 lines
4.3 KiB
Go
// Copyright 2014 Prometheus Team
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
//
|
|
// http://www.apache.org/licenses/LICENSE-2.0
|
|
//
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
|
|
package local
|
|
|
|
import (
|
|
"time"
|
|
clientmodel "github.com/prometheus/client_golang/model"
|
|
"github.com/prometheus/client_golang/prometheus"
|
|
|
|
"github.com/prometheus/prometheus/storage/metric"
|
|
)
|
|
|
|
// Storage ingests and manages samples, along with various indexes. All methods
|
|
// are goroutine-safe.
|
|
type Storage interface {
|
|
prometheus.Collector
|
|
// AppendSamples stores a group of new samples. Multiple samples for the same
|
|
// fingerprint need to be submitted in chronological order, from oldest to
|
|
// newest (both in the same call to AppendSamples and across multiple calls).
|
|
AppendSamples(clientmodel.Samples)
|
|
// NewPreloader returns a new Preloader which allows preloading and pinning
|
|
// series data into memory for use within a query.
|
|
NewPreloader() Preloader
|
|
// Get all of the metric fingerprints that are associated with the
|
|
// provided label matchers.
|
|
GetFingerprintsForLabelMatchers(metric.LabelMatchers) clientmodel.Fingerprints
|
|
// Get all of the label values that are associated with a given label name.
|
|
GetLabelValuesForLabelName(clientmodel.LabelName) clientmodel.LabelValues
|
|
// Get the metric associated with the provided fingerprint.
|
|
GetMetricForFingerprint(clientmodel.Fingerprint) clientmodel.Metric
|
|
// Construct an iterator for a given fingerprint.
|
|
NewIterator(clientmodel.Fingerprint) SeriesIterator
|
|
// Run the request-serving and maintenance loop.
|
|
Serve(started chan struct{})
|
|
// Close the MetricsStorage and releases all resources.
|
|
Close() error
|
|
// WaitForIndexing returns once all samples in the storage are
|
|
// indexed. Indexing is needed for GetFingerprintsForLabelMatchers and
|
|
// GetLabelValuesForLabelName and may lag behind.
|
|
WaitForIndexing()
|
|
}
|
|
|
|
// SeriesIterator enables efficient access of sample values in a series. All
|
|
// methods are goroutine-safe. A SeriesIterator iterates over a snapshot of a
|
|
// series, i.e. it is safe to continue using a SeriesIterator after modifying
|
|
// the corresponding series, but the iterator will represent the state of the
|
|
// series prior the modification.
|
|
type SeriesIterator interface {
|
|
// Gets the two values that are immediately adjacent to a given time. In
|
|
// case a value exist at precisely the given time, only that single
|
|
// value is returned. Only the first or last value is returned (as a
|
|
// single value), if the given time is before or after the first or last
|
|
// value, respectively.
|
|
GetValueAtTime(clientmodel.Timestamp) metric.Values
|
|
// Gets the boundary values of an interval: the first and last value
|
|
// within a given interval.
|
|
GetBoundaryValues(metric.Interval) metric.Values
|
|
// Gets all values contained within a given interval.
|
|
GetRangeValues(metric.Interval) metric.Values
|
|
}
|
|
|
|
// A Preloader preloads series data necessary for a query into memory and pins
|
|
// them until released via Close(). Its methods are generally not
|
|
// goroutine-safe.
|
|
type Preloader interface {
|
|
PreloadRange(
|
|
fp clientmodel.Fingerprint,
|
|
from clientmodel.Timestamp, through clientmodel.Timestamp,
|
|
stalenessDelta time.Duration,
|
|
) error
|
|
/*
|
|
// GetMetricAtTime loads and pins samples around a given time.
|
|
GetMetricAtTime(clientmodel.Fingerprint, clientmodel.Timestamp) error
|
|
// GetMetricAtInterval loads and pins samples at intervals.
|
|
GetMetricAtInterval(fp clientmodel.Fingerprint, from, through clientmodel.Timestamp, interval time.Duration) error
|
|
// GetMetricRange loads and pins a given range of samples.
|
|
GetMetricRange(fp clientmodel.Fingerprint, from, through clientmodel.Timestamp) error
|
|
// GetMetricRangeAtInterval loads and pins sample ranges at intervals.
|
|
GetMetricRangeAtInterval(fp clientmodel.Fingerprint, from, through clientmodel.Timestamp, interval, rangeDuration time.Duration) error
|
|
*/
|
|
// Close unpins any previously requested series data from memory.
|
|
Close()
|
|
}
|