Documentation ¶
Overview ¶
Package model contains common data structures that are shared across Prometheus componenets and libraries.
Index ¶
- Constants
- Variables
- func IsValidMetricName(n LabelValue) bool
- func LabelsToSignature(labels map[string]string) uint64
- func SignatureForLabels(m Metric, labels ...LabelName) uint64
- func SignatureWithoutLabels(m Metric, labels map[LabelName]struct{}) uint64
- type Alert
- type AlertStatus
- type Alerts
- type Duration
- type Fingerprint
- type FingerprintSet
- type Fingerprints
- type Interval
- type LabelName
- type LabelNames
- type LabelPair
- type LabelPairs
- type LabelSet
- func (ls LabelSet) Before(o LabelSet) bool
- func (ls LabelSet) Clone() LabelSet
- func (ls LabelSet) Equal(o LabelSet) bool
- func (ls LabelSet) FastFingerprint() Fingerprint
- func (ls LabelSet) Fingerprint() Fingerprint
- func (l LabelSet) Merge(other LabelSet) LabelSet
- func (l LabelSet) String() string
- func (l *LabelSet) UnmarshalJSON(b []byte) error
- func (ls LabelSet) Validate() error
- type LabelValue
- type LabelValues
- type Matcher
- type Matrix
- type Metric
- type Sample
- type SamplePair
- type SampleStream
- type SampleValue
- type Samples
- type Scalar
- type Silence
- type String
- type Time
- func (t Time) Add(d time.Duration) Time
- func (t Time) After(o Time) bool
- func (t Time) Before(o Time) bool
- func (t Time) Equal(o Time) bool
- func (t Time) MarshalJSON() ([]byte, error)
- func (t Time) String() string
- func (t Time) Sub(o Time) time.Duration
- func (t Time) Time() time.Time
- func (t Time) Unix() int64
- func (t Time) UnixNano() int64
- func (t *Time) UnmarshalJSON(b []byte) error
- type Value
- type ValueType
- type Vector
Constants ¶
const ( // AlertNameLabel is the name of the label containing the an alert's name. AlertNameLabel = "alertname" // ExportedLabelPrefix is the prefix to prepend to the label names present in // exported metrics if a label of the same name is added by the server. ExportedLabelPrefix = "exported_" // MetricNameLabel is the label name indicating the metric name of a // timeseries. MetricNameLabel = "__name__" // SchemeLabel is the name of the label that holds the scheme on which to // scrape a target. SchemeLabel = "__scheme__" // AddressLabel is the name of the label that holds the address of // a scrape target. AddressLabel = "__address__" // MetricsPathLabel is the name of the label that holds the path on which to // scrape a target. MetricsPathLabel = "__metrics_path__" // ReservedLabelPrefix is a prefix which is not legal in user-supplied // label names. ReservedLabelPrefix = "__" // MetaLabelPrefix is a prefix for labels that provide meta information. // Labels with this prefix are used for intermediate label processing and // will not be attached to time series. MetaLabelPrefix = "__meta_" // TmpLabelPrefix is a prefix for temporary labels as part of relabelling. // Labels with this prefix are used for intermediate label processing and // will not be attached to time series. This is reserved for use in // Prometheus configuration files by users. TmpLabelPrefix = "__tmp_" // ParamLabelPrefix is a prefix for labels that provide URL parameters // used to scrape a target. ParamLabelPrefix = "__param_" // JobLabel is the label name indicating the job from which a timeseries // was scraped. JobLabel = "job" // InstanceLabel is the label name used for the instance label. InstanceLabel = "instance" // BucketLabel is used for the label that defines the upper bound of a // bucket of a histogram ("le" -> "less or equal"). BucketLabel = "le" // QuantileLabel is used for the label that defines the quantile in a // summary. QuantileLabel = "quantile" )
const ( // Earliest is the earliest Time representable. Handy for // initializing a high watermark. Earliest = Time(math.MinInt64) // Latest is the latest Time representable. Handy for initializing // a low watermark. Latest = Time(math.MaxInt64) )
const SeparatorByte byte = 255
SeparatorByte is a byte that cannot occur in valid UTF-8 sequences and is used to separate label names, label values, and other strings from each other when calculating their combined hash value (aka signature aka fingerprint).
Variables ¶
var LabelNameRE = regexp.MustCompile("^[a-zA-Z_][a-zA-Z0-9_]*$")
LabelNameRE is a regular expression matching valid label names.
var (
MetricNameRE = regexp.MustCompile(`^[a-zA-Z_][a-zA-Z0-9_:]*$`)
)
Functions ¶
func IsValidMetricName ¶
func IsValidMetricName(n LabelValue) bool
IsValidMetricName returns true iff name matches the pattern of MetricNameRE.
func LabelsToSignature ¶
LabelsToSignature returns a quasi-unique signature (i.e., fingerprint) for a given label set. (Collisions are possible but unlikely if the number of label sets the function is applied to is small.)
func SignatureForLabels ¶
SignatureForLabels works like LabelsToSignature but takes a Metric as parameter (rather than a label map) and only includes the labels with the specified LabelNames into the signature calculation. The labels passed in will be sorted by this function.
func SignatureWithoutLabels ¶
SignatureWithoutLabels works like LabelsToSignature but takes a Metric as parameter (rather than a label map) and excludes the labels with any of the specified LabelNames from the signature calculation.
Types ¶
type Alert ¶
type Alert struct { // Label value pairs for purpose of aggregation, matching, and disposition // dispatching. This must minimally include an "alertname" label. Labels LabelSet `json:"labels"` // Extra key/value information which does not define alert identity. Annotations LabelSet `json:"annotations"` // The known time range for this alert. Both ends are optional. StartsAt time.Time `json:"startsAt,omitempty"` EndsAt time.Time `json:"endsAt,omitempty"` GeneratorURL string `json:"generatorURL"` }
Alert is a generic representation of an alert in the Prometheus eco-system.
func (*Alert) Fingerprint ¶
func (a *Alert) Fingerprint() Fingerprint
Fingerprint returns a unique hash for the alert. It is equivalent to the fingerprint of the alert's label set.
func (*Alert) ResolvedAt ¶
ResolvedAt returns true off the activity interval ended before the given timestamp.
type AlertStatus ¶
type AlertStatus string
const ( AlertFiring AlertStatus = "firing" AlertResolved AlertStatus = "resolved" )
type Alerts ¶
type Alerts []*Alert
Alert is a list of alerts that can be sorted in chronological order.
func (Alerts) Status ¶
func (as Alerts) Status() AlertStatus
Status returns StatusFiring iff at least one of the alerts is firing.
type Duration ¶
Duration wraps time.Duration. It is used to parse the custom duration format from YAML. This type should not propagate beyond the scope of input/output processing.
func ParseDuration ¶
StringToDuration parses a string into a time.Duration, assuming that a year a day always has 24h.
func (Duration) MarshalYAML ¶
MarshalYAML implements the yaml.Marshaler interface.
func (*Duration) UnmarshalYAML ¶
UnmarshalYAML implements the yaml.Unmarshaler interface.
type Fingerprint ¶
type Fingerprint uint64
Fingerprint provides a hash-capable representation of a Metric. For our purposes, FNV-1A 64-bit is used.
func FingerprintFromString ¶
func FingerprintFromString(s string) (Fingerprint, error)
FingerprintFromString transforms a string representation into a Fingerprint.
func ParseFingerprint ¶
func ParseFingerprint(s string) (Fingerprint, error)
ParseFingerprint parses the input string into a fingerprint.
func (Fingerprint) String ¶
func (f Fingerprint) String() string
type FingerprintSet ¶
type FingerprintSet map[Fingerprint]struct{}
FingerprintSet is a set of Fingerprints.
func (FingerprintSet) Equal ¶
func (s FingerprintSet) Equal(o FingerprintSet) bool
Equal returns true if both sets contain the same elements (and not more).
func (FingerprintSet) Intersection ¶
func (s FingerprintSet) Intersection(o FingerprintSet) FingerprintSet
Intersection returns the elements contained in both sets.
type Fingerprints ¶
type Fingerprints []Fingerprint
Fingerprints represents a collection of Fingerprint subject to a given natural sorting scheme. It implements sort.Interface.
func (Fingerprints) Less ¶
func (f Fingerprints) Less(i, j int) bool
Less implements sort.Interface.
type Interval ¶
type Interval struct {
Start, End Time
}
Interval describes and interval between two timestamps.
type LabelName ¶
type LabelName string
A LabelName is a key for a LabelSet or Metric. It has a value associated therewith.
func (*LabelName) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface.
func (*LabelName) UnmarshalYAML ¶
UnmarshalYAML implements the yaml.Unmarshaler interface.
type LabelNames ¶
type LabelNames []LabelName
LabelNames is a sortable LabelName slice. In implements sort.Interface.
func (LabelNames) Len ¶
func (l LabelNames) Len() int
func (LabelNames) Less ¶
func (l LabelNames) Less(i, j int) bool
func (LabelNames) String ¶
func (l LabelNames) String() string
func (LabelNames) Swap ¶
func (l LabelNames) Swap(i, j int)
type LabelPair ¶
type LabelPair struct { Name LabelName Value LabelValue }
LabelPair pairs a name with a value.
type LabelPairs ¶
type LabelPairs []*LabelPair
LabelPairs is a sortable slice of LabelPair pointers. It implements sort.Interface.
func (LabelPairs) Len ¶
func (l LabelPairs) Len() int
func (LabelPairs) Less ¶
func (l LabelPairs) Less(i, j int) bool
func (LabelPairs) Swap ¶
func (l LabelPairs) Swap(i, j int)
type LabelSet ¶
type LabelSet map[LabelName]LabelValue
A LabelSet is a collection of LabelName and LabelValue pairs. The LabelSet may be fully-qualified down to the point where it may resolve to a single Metric in the data store or not. All operations that occur within the realm of a LabelSet can emit a vector of Metric entities to which the LabelSet may match.
func (LabelSet) Before ¶
Before compares the metrics, using the following criteria:
If m has fewer labels than o, it is before o. If it has more, it is not.
If the number of labels is the same, the superset of all label names is sorted alphanumerically. The first differing label pair found in that order determines the outcome: If the label does not exist at all in m, then m is before o, and vice versa. Otherwise the label value is compared alphanumerically.
If m and o are equal, the method returns false.
func (LabelSet) Equal ¶
Equal returns true iff both label sets have exactly the same key/value pairs.
func (LabelSet) FastFingerprint ¶
func (ls LabelSet) FastFingerprint() Fingerprint
FastFingerprint returns the LabelSet's Fingerprint calculated by a faster hashing algorithm, which is, however, more susceptible to hash collisions.
func (LabelSet) Fingerprint ¶
func (ls LabelSet) Fingerprint() Fingerprint
Fingerprint returns the LabelSet's fingerprint.
func (*LabelSet) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface.
type LabelValue ¶
type LabelValue string
A LabelValue is an associated value for a LabelName.
func (LabelValue) IsValid ¶
func (lv LabelValue) IsValid() bool
IsValid returns true iff the string is a valid UTF8.
type LabelValues ¶
type LabelValues []LabelValue
LabelValues is a sortable LabelValue slice. It implements sort.Interface.
func (LabelValues) Len ¶
func (l LabelValues) Len() int
func (LabelValues) Less ¶
func (l LabelValues) Less(i, j int) bool
func (LabelValues) Swap ¶
func (l LabelValues) Swap(i, j int)
type Matcher ¶
type Matcher struct { Name LabelName `json:"name"` Value string `json:"value"` IsRegex bool `json:"isRegex"` }
Matcher describes a matches the value of a given label.
func (*Matcher) UnmarshalJSON ¶
type Metric ¶
type Metric LabelSet
A Metric is similar to a LabelSet, but the key difference is that a Metric is a singleton and refers to one and only one stream of samples.
func (Metric) FastFingerprint ¶
func (m Metric) FastFingerprint() Fingerprint
FastFingerprint returns a Metric's Fingerprint calculated by a faster hashing algorithm, which is, however, more susceptible to hash collisions.
func (Metric) Fingerprint ¶
func (m Metric) Fingerprint() Fingerprint
Fingerprint returns a Metric's Fingerprint.
type Sample ¶
type Sample struct { Metric Metric `json:"metric"` Value SampleValue `json:"value"` Timestamp Time `json:"timestamp"` }
Sample is a sample pair associated with a metric.
func (Sample) MarshalJSON ¶
MarshalJSON implements json.Marshaler.
func (*Sample) UnmarshalJSON ¶
UnmarshalJSON implements json.Unmarshaler.
type SamplePair ¶
type SamplePair struct { Timestamp Time Value SampleValue }
SamplePair pairs a SampleValue with a Timestamp.
func (*SamplePair) Equal ¶
func (s *SamplePair) Equal(o *SamplePair) bool
Equal returns true if this SamplePair and o have equal Values and equal Timestamps.
func (SamplePair) MarshalJSON ¶
func (s SamplePair) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler.
func (SamplePair) String ¶
func (s SamplePair) String() string
func (*SamplePair) UnmarshalJSON ¶
func (s *SamplePair) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type SampleStream ¶
type SampleStream struct { Metric Metric `json:"metric"` Values []SamplePair `json:"values"` }
SampleStream is a stream of Values belonging to an attached COWMetric.
func (SampleStream) String ¶
func (ss SampleStream) String() string
type SampleValue ¶
type SampleValue float64
A SampleValue is a representation of a value for a given sample at a given time.
func (SampleValue) Equal ¶
func (v SampleValue) Equal(o SampleValue) bool
func (SampleValue) MarshalJSON ¶
func (v SampleValue) MarshalJSON() ([]byte, error)
MarshalJSON implements json.Marshaler.
func (SampleValue) String ¶
func (v SampleValue) String() string
func (*SampleValue) UnmarshalJSON ¶
func (v *SampleValue) UnmarshalJSON(b []byte) error
UnmarshalJSON implements json.Unmarshaler.
type Samples ¶
type Samples []*Sample
Samples is a sortable Sample slice. It implements sort.Interface.
type Scalar ¶
type Scalar struct { Value SampleValue `json:"value"` Timestamp Time `json:"timestamp"` }
Scalar is a scalar value evaluated at the set timestamp.
func (Scalar) MarshalJSON ¶
MarshalJSON implements json.Marshaler.
func (*Scalar) UnmarshalJSON ¶
UnmarshalJSON implements json.Unmarshaler.
type Silence ¶
type Silence struct { ID uint64 `json:"id,omitempty"` Matchers []*Matcher `json:"matchers"` StartsAt time.Time `json:"startsAt"` EndsAt time.Time `json:"endsAt"` CreatedAt time.Time `json:"createdAt,omitempty"` CreatedBy string `json:"createdBy"` Comment string `json:"comment,omitempty"` }
Silence defines the representation of a silence definiton in the Prometheus eco-system.
type String ¶
String is a string value evaluated at the set timestamp.
func (String) MarshalJSON ¶
MarshalJSON implements json.Marshaler.
func (*String) UnmarshalJSON ¶
UnmarshalJSON implements json.Unmarshaler.
type Time ¶
type Time int64
Time is the number of milliseconds since the epoch (1970-01-01 00:00 UTC) excluding leap seconds.
func TimeFromUnix ¶
TimeFromUnix returns the Time equivalent to the Unix Time t provided in seconds.
func TimeFromUnixNano ¶
TimeFromUnixNano returns the Time equivalent to the Unix Time t provided in nanoseconds.
func (Time) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface.
func (Time) Unix ¶
Unix returns t as a Unix time, the number of seconds elapsed since January 1, 1970 UTC.
func (Time) UnixNano ¶
UnixNano returns t as a Unix time, the number of nanoseconds elapsed since January 1, 1970 UTC.
func (*Time) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface.
type ValueType ¶
type ValueType int
func (ValueType) MarshalJSON ¶
MarshalJSON implements json.Marshaler.
func (*ValueType) UnmarshalJSON ¶
type Vector ¶
type Vector []*Sample
Vector is basically only an alias for Samples, but the contract is that in a Vector, all Samples have the same timestamp.