promslog: Make AllowedLevel concurrency safe. #754
Conversation
Needed for prometheus/prometheus#10352 Also I renamed AllowedLevel and AllowedFormat to Level and Format. Default level (and String()) is also now 'info' not empty. It's a breaking change, but I suspect nobody was using those constructs directly, WDYT? Signed-off-by: bwplotka <[email protected]>
| err := yaml.Unmarshal([]byte(``), l) | ||
| if err != nil { | ||
| t.Error(err) | ||
| } | ||
| if l.s != "" { | ||
| t.Errorf("expected empty level, got %s", l.s) | ||
| if got := l.String(); got != "info" { |
There was a problem hiding this comment.
I changed the behaviour purposefully. This simplifies (and optimizes) the level code.
I don't know exactly how Unmarshal and String was envisioned to be used in the YAML context. Does this blocks anyone?
| type AllowedFormat struct { | ||
| // Format controls a logging output format. | ||
| // Not concurrency-safe. | ||
| type Format struct { |
There was a problem hiding this comment.
As mentioned in the description - this is a breaking change, let me know if this is ok.
There was a problem hiding this comment.
Yes, OK this breaking change.
Any chance you would keep the old struct around and add a Deprecated comment so downstream Go users get a linter warning?
There was a problem hiding this comment.
Or, maybe it's better to just drop the struct so it's a compile error.
There was a problem hiding this comment.
For deprecated flow we would need to maintain a behaviour which means promslog.Config using old thing, we can but until we are v1 and this is not too painful we can break.
| // Level controls a logging level, with an info default. | ||
| // It wraps slog.LevelVar with string-based level control. | ||
| // Level is safe to be used concurrently. | ||
| type Level struct { |
There was a problem hiding this comment.
As mentioned in the description - this (rename) is a breaking change, let me know if this is ok.
Signed-off-by: bwplotka <[email protected]>
There are at least a few that I know of: promtheus json file logger: prom api testing blackbox exporter custom probe logging (handler.go and handler_test.go) Updates shouldn't be difficult, but a few will be needed after the breaking change |
Needed for prometheus/prometheus#10352
Also I renamed AllowedLevel and AllowedFormat to Level and Format. Default level (and String()) is also now 'info' not empty.
It's a breaking change, but I suspect nobody was using those constructs directly, WDYT?
cc @tjhop