promlint: Add timestamp_seconds suffix restriction #1520
Conversation
assafad
force-pushed
the
timestamp_seconds-suffix
branch
4 times, most recently
from
fddb26c
to
5810fbe
Compare
Allow using timestamp_seconds suffix only for gauge metrics. Signed-off-by: Assaf Admi <aadmi@redhat.com>
assafad
force-pushed
the
timestamp_seconds-suffix
branch
from
5810fbe
to
e7c96fd
Compare
|
@ArthurSens Can you please review this PR? |
|
Isn't there a linter that already fails if a counter doesn't end with |
@ArthurSens For counters yes, but it won't catch other metrics types using the |
| name: "counter with _timestamp_seconds suffix", | ||
| in: ` | ||
| # HELP _timestamp_seconds Test metric. | ||
| # TYPE _timestamp_seconds counter |
There was a problem hiding this comment.
Side note: Metrics starting with underscore should be a problem too 🙈
| @@ -499,6 +499,63 @@ x_bytes 10 | |||
| runTests(t, tests) | |||
| } | |||
|
|
|||
| func TestLintGauge(t *testing.T) { | |||
| Text: `counter metrics should have "_total" suffix`, | ||
| }, | ||
| { | ||
| Metric: "_timestamp_seconds", |
There was a problem hiding this comment.
This does not feel helpful for counters, the above problem duplicates here kind of and is kind of awkward why timestamp_second is not allowed. Can I do ts_seconds?
|
|
||
| // LintGauge detects issues specific to gauges, as well as patterns that should | ||
| // only be used with gauges. | ||
| func LintGauge(mf *dto.MetricFamily) []error { |
There was a problem hiding this comment.
Hm, so this feels bit wrong. Name suggests we lint gauges, but looks like we simply lint non-gauges. I would move this to related types one by one.... but is there one?
For counters we don't need this, because _total check would be failed. For histograms and summaries, I think they are always cumulative so this check should be there too (I don't think it's implemented?).
So what we are left with? On what case you got hit by this?
|
@bwplotka thanks for your review :) |
What this PR does
Add a rule to promlint, restricting
timestamp_secondssuffix for non-gauge metrics.timestamp_secondsmetrics are not cumulative and shouldn't be split to buckets or quantiles. They should be of gauge type.For example, in https://kubernetes.io/docs/reference/instrumentation/metrics/#list-of-stable-kubernetes-metrics and https://github.com/kubernetes/kube-state-metrics/tree/main/docs/metrics, all
timestamp_secondsmetrics are gauges.