Repository navigation
Conversation
b7231f5 to
57c6fb1
Compare
|
@schwesig note that I have rebased this PR on main (so that the label workflow passses); you will want to update your local working copy before making any changes. |
|
Not all required reviewers assigned yet. Do not merge. |
b13b746 to
948343b
Compare
|
Adding required reviewers. Need three approvals for merge: David, Kristi and one Red Hatter who is not the author (already done). |
|
Looks decision looks reasonable on the first read, but I'll take a deeper look later. Please define acronyms when they are first introduced in the ADR is the one suggestion based on the first pass. |
|
You have flushed out a problem with our pre-commit configuration. Thank you! I've proposed a fix in #45. |
| - **Our use of it is not documented.** A general name pattern in the custom allowlist works on ACM | ||
| 2.17.3, and the hub's own default list | ||
| uses it, but the guide documents only `names` and `recording_rules`. |
There was a problem hiding this comment.
What exactly is undocumented -- our use of matches:?
There was a problem hiding this comment.
@larsks yes, the matches: field with a name regex.
- matches: is real and in production, the hub's own default allowlist carries 13 entries
- but the guide shows it only inside collect_rules, for dynamic SNO (Single Node OpenShift) metrics, with name pinned to one value
- for the custom allowlist it documents names and recording_rules only
- what I could not find anywhere is a general name pattern like name=~"ovs_.*" in it
--> so it is measured behaviour, not a described one
There was a problem hiding this comment.
see commit, I changed it, hopefully better described...
There was a problem hiding this comment.
sources:
| ### Why the gap is maintenance, not technology | ||
|
|
||
| Editing the selection is routine work and does not reopen this decision. CCI-MOC/oac-apps#140 is | ||
| exactly that: three names added, documented mechanism, no change of model. That holds with `names:` | ||
| alone, which is what the argument rests on. | ||
|
|
||
| A pattern makes a bulk addition more convenient — `matches: [__name__=~"ovs_.*"]` took `ovs_*` from 0 | ||
| to 86 names across all three clusters, see [measurements.md](measurements.md) — but it is a | ||
| convenience on top, not the reason the model is affordable. | ||
|
|
||
| What stays true is that a metric **no existing selector matches** does not reach the hub, and | ||
| nothing reports that it is missing. A pattern shifts where that line sits, it does not remove it. |
There was a problem hiding this comment.
I am not entirely sure what this section is trying to convey. Most of the points here have been made previously.
There was a problem hiding this comment.
@larsks kind of, yes. I need to rewrite that and think, what was really the reason why I repeated that..
I tried to sum up and got lost.
What I meant:
- if wildcard/matches works... great, saves time and manual work
- if only names works (e.g. Red Hat does not support it anymore), then we just need to add e.g 86 name lines (instead of 1 wildcard)
so nothing depends on wildcard/matches --> not a K.O. criteria here
There was a problem hiding this comment.
I remove that chapter...
good point.
dsmk
left a comment
There was a problem hiding this comment.
Decision seems reasonable to me - use the central logging approach from MOC 1.0 in a way that we can enhance/shift later. That way we can focus on other things in the short term.
I am approving this ADR with the provision that the documentation updates Lars and I added are addressed.
fecd698 to
f7cd4db
Compare
f7cd4db to
528d63e
Compare
MCO collects by allowlist, 227 pinned --match arguments against the local Prometheus. We run it that way becuase the goal was to stay close to MOC 1.0, not after comparing it with the alternative. Measured on the dev hub: MCO does pass a non-pinned matcher through, but Prometheus joins several match[] selectors with OR, so a negative matcher next to the existing 227 excludes nothing. The docs cover removing single metrics by name and say nothing about patterns. So we keep the allowlist as the model, not its contents, and write down what the measurements showed for whoever revisits this.
Co-authored-by: Lars Kellogg-Stedman <lars@oddbit.com>
larsks asked which path the metrics take, and the question was right: the central figure described one path and was reported as the whole. Corrected, together with his other three comments. The decision now rests on the documented mechanism alone, a name pattern is recorded as a convenience rather than as its justification, and the three selections that were conflated are told apart: the control plane drop list, local collection in UWM, and what reaches the hub. Measurement detail and the query recipes move to measurements.md and querying.md next to the ADR. That keeps the ADR readable without losing what somebody debugging a metric needs, and it is a new convention here, so say if you would rather have it in one file.
Retitles the ADR, tightens the context paragraph and folds a few asides into the sentences they belong to. No change of substance; this replaces seven consecutive web editor saves from the same sitting.
The bullet said "our use of it" and left the reader to work out what "it" pointed at. The key itself is documented and the hub's default list uses it; what the guide does not show is a general name pattern in the custom allowlist.
All three paragraphs said something the ADR had already said: oac-apps#140 as a routine addition appears four times before this, the ovs_* measurement twice, and the quiet gap when no selector matches twice. What only this section carried, that the decision rests on names: alone and a pattern is convenience, is already the closing paragraph of "Caveat on the pattern", stated better there.
528d63e to
0e5aac6
Compare
|
This requires a review from a Mass Open Cloud person. @naved001 please complete this, as you are the MOC person most familiar with metrics collection in general. |
naved001
left a comment
There was a problem hiding this comment.
Looks fine to me, just left some nit picky comments that you could take it or leave it.
The sentence about a metric no selector matches read as if it were kept. And the ownership paragraph said the same thing as the one in the context section.
A blank line between the table and the list below it, and two places with a doubled blank line.
Records why we collect central metrics by allowlist, and what we measured when we asked whether a block list would work instead.
Short version:
MCO does accept a broad matcher, but Prometheus joins the
match[]selectors with OR, so a negative one next to the existing 227 excludes nothing.The docs cover removing single metrics by name and say nothing about patterns.
So we keep the model, not the contents, and write the measurements down for whoever picks this up again.