Bring Gauges and Counters in line with client library guidelines #259
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Nov 18, 2016
| @@ -30,7 +30,8 @@ type Counter interface { | |||
| Metric | |||
| Collector | |||
|
|
|||
| // Inc increments the counter by 1. | |||
| // Inc increments the counter by 1. Use Add to increment it by arbitrary | |||
| // positive values. | |||
There was a problem hiding this comment.
non-negative
Zero is okay.
- Deprecate Untyped for direct instrumentation. - Add a SetToCurrentTime method to Gauge Note that adding the SetToCurrentTime method is not really following Go's principle of lean interfaces. However, the Gauge interface is already quite fat. (The only methods really required are Set and Add. Everything else could be expressed in terms of those two.) So we have already quite a few "convenience" methods traditionally, so I think we should stay consistent here. The alternatives would be: - Not support SetToCurrentTime at all (it's only a SHOULD in the guidelines). - A top level function `SetToCurrentTime(Gauge)`. - Just a helper `CurrentTime()` that returns the curent unix time in seconds as a float (which is pretty verbose using the standard library, see code in this commit). This would allow `myGauge.Set(CurrentTime)`. Weighing all circumstances, I believe the way in this commit is the least evil. Issue #223 could be used to rework interfaces more fundamentally in a breaking change if feasible.
beorn7
force-pushed
the
beorn7/guideline-compliance
branch
from
d32b70d
to
606b8f8
Compare
|
I'll merge this for now. If radical Gophers have issues with the new method, we can discuss later. |
|
|
||
| delta := unixTime - m.GetGauge().GetValue() | ||
| // This is just a smoke test to make sure SetToCurrentTime is not | ||
| // totally off. Tests with current time involved are hard... |
There was a problem hiding this comment.
I think this approach is fine, especially given the simplicity of the method invoked.
|
👍 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Point from Inc and Dec to Add and Sub in doc comments.
Deprecate Untyped for direct instrumentation.
Add a SetToCurrentTime method to Gauge
Note that adding the SetToCurrentTime method is not really following
Go's principle of lean interfaces. However, the Gauge interface is
already quite fat. (The only methods really required are Set and
Add. Everything else could be expressed in terms of those two.) So we
have already quite a few "convenience" methods traditionally, so I
think we should stay consistent here.
The alternatives would be:
Not support SetToCurrentTime at all (it's only a SHOULD in the
guidelines).
A top level function
SetToCurrentTime(Gauge).Just a helper
CurrentTime()that returns the curent unix time inseconds as a float (which is pretty verbose using the standard
library, see code in this commit). This would allow
myGauge.Set(CurrentTime).Weighing all circumstances, I believe the way in this commit is the
least evil. Issue #223 could be used to rework interfaces more
fundamentally in a breaking change if feasible.
@brian-brazil for guideline compliance
@stuartnelson3 for Go