2024-01-14 20:46:06 +00:00
|
|
|
package prompb_test
|
|
|
|
|
|
|
|
import (
|
|
|
|
"bytes"
|
|
|
|
"testing"
|
|
|
|
|
|
|
|
"github.com/VictoriaMetrics/VictoriaMetrics/lib/prompb"
|
|
|
|
"github.com/VictoriaMetrics/VictoriaMetrics/lib/prompbmarshal"
|
|
|
|
)
|
|
|
|
|
|
|
|
func TestWriteRequestUnmarshalProtobuf(t *testing.T) {
|
|
|
|
var wr prompb.WriteRequest
|
|
|
|
|
|
|
|
f := func(data []byte) {
|
|
|
|
t.Helper()
|
|
|
|
|
|
|
|
// Verify that the marshaled protobuf is unmarshaled properly
|
|
|
|
if err := wr.UnmarshalProtobuf(data); err != nil {
|
|
|
|
t.Fatalf("cannot unmarshal protobuf: %s", err)
|
|
|
|
}
|
|
|
|
|
|
|
|
// Compare the unmarshaled wr with the original wrm.
|
|
|
|
var wrm prompbmarshal.WriteRequest
|
|
|
|
for _, ts := range wr.Timeseries {
|
|
|
|
var labels []prompbmarshal.Label
|
|
|
|
for _, label := range ts.Labels {
|
|
|
|
labels = append(labels, prompbmarshal.Label{
|
|
|
|
Name: label.Name,
|
|
|
|
Value: label.Value,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
var samples []prompbmarshal.Sample
|
|
|
|
for _, sample := range ts.Samples {
|
|
|
|
samples = append(samples, prompbmarshal.Sample{
|
|
|
|
Value: sample.Value,
|
|
|
|
Timestamp: sample.Timestamp,
|
|
|
|
})
|
|
|
|
}
|
|
|
|
wrm.Timeseries = append(wrm.Timeseries, prompbmarshal.TimeSeries{
|
Revert "Exemplar support (#5982)"
This reverts commit 5a3abfa0414ab495cbc34a58146b540aa8289636.
Reason for revert: exemplars aren't in wide use because they have numerous issues which prevent their adoption (see below).
Adding support for examplars into VictoriaMetrics introduces non-trivial code changes. These code changes need to be supported forever
once the release of VictoriaMetrics with exemplar support is published. That's why I don't think this is a good feature despite
that the source code of the reverted commit has an excellent quality. See https://docs.victoriametrics.com/goals/ .
Issues with Prometheus exemplars:
- Prometheus still has only experimental support for exemplars after more than three years since they were introduced.
It stores exemplars in memory, so they are lost after Prometheus restart. This doesn't look like production-ready feature.
See https://github.com/prometheus/docs/blob/0a2f3b37940e2949eefe752ed7b6c768e0b00128/content/docs/instrumenting/exposition_formats.md?plain=1#L153-L159
and https://prometheus.io/docs/prometheus/latest/feature_flags/#exemplars-storage
- It is very non-trivial to expose exemplars alongside metrics in your application, since the official Prometheus SDKs
for metrics' exposition ( https://prometheus.io/docs/instrumenting/clientlibs/ ) either have very hard-to-use API
for exposing histograms or do not have this API at all. For example, try figuring out how to expose exemplars
via https://pkg.go.dev/github.com/prometheus/client_golang@v1.19.1/prometheus .
- It looks like exemplars are supported for Histogram metric types only -
see https://pkg.go.dev/github.com/prometheus/client_golang@v1.19.1/prometheus#Timer.ObserveDurationWithExemplar .
Exemplars aren't supported for Counter, Gauge and Summary metric types.
- Grafana has very poor support for Prometheus exemplars. It looks like it supports exemplars only when the query
contains histogram_quantile() function. It queries exemplars via special Prometheus API -
https://prometheus.io/docs/prometheus/latest/querying/api/#querying-exemplars - (which is still marked as experimental, btw.)
and then displays all the returned exemplars on the graph as special dots. The issue is that this doesn't work
in production in most cases when the histogram_quantile() is calculated over thousands of histogram buckets
exposed by big number of application instances. Every histogram bucket may expose an exemplar on every timestamp shown on the graph.
This makes the graph unusable, since it is litterally filled with thousands of exemplar dots.
Neither Prometheus API nor Grafana doesn't provide the ability to filter out unneeded exemplars.
- Exemplars are usually connected to traces. While traces are good for some
I doubt exemplars will become production-ready in the near future because of the issues outlined above.
Alternative to exemplars:
Exemplars are marketed as a silver bullet for the correlation between metrics, traces and logs -
just click the exemplar dot on some graph in Grafana and instantly see the corresponding trace or log entry!
This doesn't work as expected in production as shown above. Are there better solutions, which work in production?
Yes - just use time-based and label-based correlation between metrics, traces and logs. Assign the same `job`
and `instance` labels to metrics, logs and traces, so you can quickly find the needed trace or log entry
by these labes on the time range with the anomaly on metrics' graph.
Updates https://github.com/VictoriaMetrics/VictoriaMetrics/pull/5982
2024-07-03 13:30:11 +00:00
|
|
|
Labels: labels,
|
|
|
|
Samples: samples,
|
2024-01-14 20:46:06 +00:00
|
|
|
})
|
|
|
|
}
|
2024-01-14 21:04:45 +00:00
|
|
|
dataResult := wrm.MarshalProtobuf(nil)
|
2024-01-14 20:46:06 +00:00
|
|
|
if !bytes.Equal(dataResult, data) {
|
|
|
|
t.Fatalf("unexpected data obtained after marshaling\ngot\n%X\nwant\n%X", dataResult, data)
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
2024-01-14 21:04:45 +00:00
|
|
|
var data []byte
|
2024-01-14 20:46:06 +00:00
|
|
|
wrm := &prompbmarshal.WriteRequest{}
|
2024-01-14 21:04:45 +00:00
|
|
|
|
|
|
|
wrm.Reset()
|
|
|
|
data = wrm.MarshalProtobuf(data[:0])
|
2024-01-14 20:46:06 +00:00
|
|
|
f(data)
|
|
|
|
|
2024-01-14 21:04:45 +00:00
|
|
|
wrm.Reset()
|
2024-01-14 20:46:06 +00:00
|
|
|
wrm.Timeseries = []prompbmarshal.TimeSeries{
|
|
|
|
{
|
|
|
|
Labels: []prompbmarshal.Label{
|
|
|
|
{
|
|
|
|
Name: "__name__",
|
|
|
|
Value: "process_cpu_seconds_total",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Name: "instance",
|
|
|
|
Value: "host-123:4567",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Name: "job",
|
|
|
|
Value: "node-exporter",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
2024-01-14 21:04:45 +00:00
|
|
|
data = wrm.MarshalProtobuf(data[:0])
|
2024-01-14 20:46:06 +00:00
|
|
|
f(data)
|
|
|
|
|
2024-01-14 21:04:45 +00:00
|
|
|
wrm.Reset()
|
2024-01-14 20:46:06 +00:00
|
|
|
wrm.Timeseries = []prompbmarshal.TimeSeries{
|
|
|
|
{
|
|
|
|
Samples: []prompbmarshal.Sample{
|
|
|
|
{
|
|
|
|
Value: 123.3434,
|
|
|
|
Timestamp: 8939432423,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Value: -123.3434,
|
|
|
|
Timestamp: 18939432423,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
2024-01-14 21:04:45 +00:00
|
|
|
data = wrm.MarshalProtobuf(data[:0])
|
2024-01-14 20:46:06 +00:00
|
|
|
f(data)
|
|
|
|
|
2024-01-14 21:04:45 +00:00
|
|
|
wrm.Reset()
|
2024-01-14 20:46:06 +00:00
|
|
|
wrm.Timeseries = []prompbmarshal.TimeSeries{
|
|
|
|
{
|
|
|
|
Labels: []prompbmarshal.Label{
|
|
|
|
{
|
|
|
|
Name: "__name__",
|
|
|
|
Value: "process_cpu_seconds_total",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Name: "instance",
|
|
|
|
Value: "host-123:4567",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Name: "job",
|
|
|
|
Value: "node-exporter",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
Samples: []prompbmarshal.Sample{
|
|
|
|
{
|
|
|
|
Value: 123.3434,
|
|
|
|
Timestamp: 8939432423,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Value: -123.3434,
|
|
|
|
Timestamp: 18939432423,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
2024-01-14 21:04:45 +00:00
|
|
|
data = wrm.MarshalProtobuf(data[:0])
|
2024-01-14 20:46:06 +00:00
|
|
|
f(data)
|
|
|
|
|
2024-01-14 21:04:45 +00:00
|
|
|
wrm.Reset()
|
2024-01-14 20:46:06 +00:00
|
|
|
wrm.Timeseries = []prompbmarshal.TimeSeries{
|
|
|
|
{
|
|
|
|
Labels: []prompbmarshal.Label{
|
|
|
|
{
|
|
|
|
Name: "__name__",
|
|
|
|
Value: "process_cpu_seconds_total",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Name: "instance",
|
|
|
|
Value: "host-123:4567",
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Name: "job",
|
|
|
|
Value: "node-exporter",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
Samples: []prompbmarshal.Sample{
|
|
|
|
{
|
|
|
|
Value: 123.3434,
|
|
|
|
Timestamp: 8939432423,
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Value: -123.3434,
|
|
|
|
Timestamp: 18939432423,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
{
|
|
|
|
Labels: []prompbmarshal.Label{
|
|
|
|
{
|
|
|
|
Name: "foo",
|
|
|
|
Value: "bar",
|
|
|
|
},
|
|
|
|
},
|
|
|
|
Samples: []prompbmarshal.Sample{
|
|
|
|
{
|
|
|
|
Value: 9873,
|
|
|
|
},
|
|
|
|
},
|
|
|
|
},
|
|
|
|
}
|
2024-01-14 21:04:45 +00:00
|
|
|
data = wrm.MarshalProtobuf(data[:0])
|
2024-01-14 20:46:06 +00:00
|
|
|
f(data)
|
|
|
|
}
|