mirror of
https://github.com/prometheus/prometheus.git
synced 2025-02-02 08:31:11 -08:00
740d448983
So far we've been using Go's native time.Time for anything related to sample timestamps. Since the range of time.Time is much bigger than what we need, this has created two problems: - there could be time.Time values which were out of the range/precision of the time type that we persist to disk, therefore causing incorrectly ordered keys. One bug caused by this was: https://github.com/prometheus/prometheus/issues/367 It would be good to use a timestamp type that's more closely aligned with what the underlying storage supports. - sizeof(time.Time) is 192, while Prometheus should be ok with a single 64-bit Unix timestamp (possibly even a 32-bit one). Since we store samples in large numbers, this seriously affects memory usage. Furthermore, copying/working with the data will be faster if it's smaller. *MEMORY USAGE RESULTS* Initial memory usage comparisons for a running Prometheus with 1 timeseries and 100,000 samples show roughly a 13% decrease in total (VIRT) memory usage. In my tests, this advantage for some reason decreased a bit the more samples the timeseries had (to 5-7% for millions of samples). This I can't fully explain, but perhaps garbage collection issues were involved. *WHEN TO USE THE NEW TIMESTAMP TYPE* The new clientmodel.Timestamp type should be used whenever time calculations are either directly or indirectly related to sample timestamps. For example: - the timestamp of a sample itself - all kinds of watermarks - anything that may become or is compared to a sample timestamp (like the timestamp passed into Target.Scrape()). When to still use time.Time: - for measuring durations/times not related to sample timestamps, like duration telemetry exporting, timers that indicate how frequently to execute some action, etc. *NOTE ON OPERATOR OPTIMIZATION TESTS* We don't use operator optimization code anymore, but it still lives in the code as dead code. It still has tests, but I couldn't get all of them to pass with the new timestamp format. I commented out the failing cases for now, but we should probably remove the dead code soon. I just didn't want to do that in the same change as this. Change-Id: I821787414b0debe85c9fffaeb57abd453727af0f
76 lines
2.8 KiB
Go
76 lines
2.8 KiB
Go
// Copyright 2013 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 metric
|
|
|
|
import (
|
|
clientmodel "github.com/prometheus/client_golang/model"
|
|
|
|
"github.com/prometheus/prometheus/storage"
|
|
)
|
|
|
|
// AppendBatch models a batch of samples to be stored.
|
|
type AppendBatch map[clientmodel.Fingerprint]SampleSet
|
|
|
|
// MetricPersistence is a system for storing metric samples in a persistence
|
|
// layer.
|
|
type MetricPersistence interface {
|
|
// A storage system may rely on external resources and thusly should be
|
|
// closed when finished.
|
|
Close()
|
|
|
|
// Record a group of new samples in the storage layer.
|
|
AppendSamples(clientmodel.Samples) error
|
|
|
|
// Get all of the metric fingerprints that are associated with the provided
|
|
// label set.
|
|
GetFingerprintsForLabelSet(clientmodel.LabelSet) (clientmodel.Fingerprints, error)
|
|
|
|
// Get all of the metric fingerprints that are associated for a given label
|
|
// name.
|
|
GetFingerprintsForLabelName(clientmodel.LabelName) (clientmodel.Fingerprints, error)
|
|
|
|
// Get the metric associated with the provided fingerprint.
|
|
GetMetricForFingerprint(*clientmodel.Fingerprint) (clientmodel.Metric, error)
|
|
|
|
// Get the two metric values that are immediately adjacent to a given time.
|
|
GetValueAtTime(*clientmodel.Fingerprint, clientmodel.Timestamp) Values
|
|
// Get the boundary values of an interval: the first value older than the
|
|
// interval start, and the first value younger than the interval end.
|
|
GetBoundaryValues(*clientmodel.Fingerprint, Interval) Values
|
|
// Get all values contained within a provided interval.
|
|
GetRangeValues(*clientmodel.Fingerprint, Interval) Values
|
|
// Get all label values that are associated with a given label name.
|
|
GetAllValuesForLabel(clientmodel.LabelName) (clientmodel.LabelValues, error)
|
|
}
|
|
|
|
// View provides a view of the values in the datastore subject to the request
|
|
// of a preloading operation.
|
|
type View interface {
|
|
GetValueAtTime(*clientmodel.Fingerprint, clientmodel.Timestamp) Values
|
|
GetBoundaryValues(*clientmodel.Fingerprint, Interval) Values
|
|
GetRangeValues(*clientmodel.Fingerprint, Interval) Values
|
|
|
|
// Destroy this view.
|
|
Close()
|
|
}
|
|
|
|
type Series interface {
|
|
Fingerprint() *clientmodel.Fingerprint
|
|
Metric() clientmodel.Metric
|
|
}
|
|
|
|
type IteratorsForFingerprintBuilder interface {
|
|
ForStream(stream *stream) (storage.RecordDecoder, storage.RecordFilter, storage.RecordOperator)
|
|
}
|