mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
Michael SnowdenandGitHub
c8668436e7
## What changed?
<!-- Describe what has changed in this PR -->
I created new structs that embed `metricDefinition` (e.g.
`histogramDefinition`), and I added a `With(Handler)` method to each of
them. I also added an example that migrates the usage of `Handler` to
this new approach, for one of each type of metric definition.
If this lands, I will also create an issue with the "good first issue"
tag to migrate all usage to the new approach. There's no need to do it
right away, though.
## Why?
<!-- Tell your future self why have you made these changes -->
Previously, usage of our `metrics.Handler` could be both redundant and
unsafe:
```
handler.Histogram( myHisto.Name(), myHisto.Unit() ).Record(...)
│ │ └───┐
│ │ │
└─────┐ └───────────┐ │
│ │ │
Redundant and Unsafe: 'Histogram' │ │
is specified despite knowing │ │
'myHisto' is a histogram. There's │ │
also a risk if 'myHisto.Name()' │ │
refers to a metric definition that │ │
is not a histogram. │ │
└─── Redundant information
```
If you use the new `With(Handler)` method, there's no need to specify
redundant information.
## How did you test it?
<!-- How have you verified this change? Tested locally? Added a unit
test? Checked in staging env? -->
I added an `ExampleHandler` which tests all the new methods and also
serves as documentation on how to use the `Handler`, to encourage people
to use the new approach.
## Potential risks
<!-- Assuming the worst case, what can be broken when deploying this
change to production? -->
People can still use the old approach after this PR lands because we are
keeping the `Handler` interface as-is. However, we need to do that
because we can't break existing users / implementors.
## Is hotfix candidate?
<!-- Is this PR a hotfix candidate or does it require a notification to
be sent to the broader community? (Yes/No) -->
No.
78 lines
2.6 KiB
Go
78 lines
2.6 KiB
Go
// The MIT License
|
|
//
|
|
// Copyright (c) 2020 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2020 Uber Technologies, Inc.
|
|
//
|
|
// Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
// of this software and associated documentation files (the "Software"), to deal
|
|
// in the Software without restriction, including without limitation the rights
|
|
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
// copies of the Software, and to permit persons to whom the Software is
|
|
// furnished to do so, subject to the following conditions:
|
|
//
|
|
// The above copyright notice and this permission notice shall be included in
|
|
// all copies or substantial portions of the Software.
|
|
//
|
|
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
// THE SOFTWARE.
|
|
|
|
package metrics_test
|
|
|
|
import (
|
|
"fmt"
|
|
"time"
|
|
|
|
"go.temporal.io/server/common/metrics"
|
|
"go.temporal.io/server/common/metrics/metricstest"
|
|
"golang.org/x/exp/maps"
|
|
"golang.org/x/exp/slices"
|
|
)
|
|
|
|
var (
|
|
bytesHist = metrics.NewBytesHistogramDef("test-bytes-histogram")
|
|
counter = metrics.NewCounterDef("test-counter")
|
|
gauge = metrics.NewGaugeDef("test-gauge")
|
|
hist = metrics.NewDimensionlessHistogramDef("test-histogram")
|
|
timer = metrics.NewTimerDef("test-timer")
|
|
)
|
|
|
|
func ExampleHandler() {
|
|
handler := metricstest.NewCaptureHandler()
|
|
capture := handler.StartCapture()
|
|
|
|
// Instead of calling handler.Histogram(bytesHist.Name(), bytesHist.Unit()).Record(1), you should use the With
|
|
// method of the metric definition instead.
|
|
|
|
bytesHist.With(handler).Record(1)
|
|
counter.With(handler).Record(2)
|
|
gauge.With(handler).Record(3)
|
|
hist.With(handler).Record(4)
|
|
timer.With(handler).Record(5 * time.Second)
|
|
|
|
snapshot := capture.Snapshot()
|
|
keys := maps.Keys(snapshot)
|
|
slices.Sort(keys)
|
|
for _, key := range keys {
|
|
fmt.Printf("%s:", key)
|
|
for _, rec := range snapshot[key] {
|
|
fmt.Printf(" %v (%v)", rec.Value, rec.Unit)
|
|
}
|
|
fmt.Println()
|
|
}
|
|
|
|
// Notice that the output includes the proper units without having to specify them in the call to Record.
|
|
|
|
// Output:
|
|
// test-bytes-histogram: 1 (By)
|
|
// test-counter: 2 ()
|
|
// test-gauge: 3 ()
|
|
// test-histogram: 4 (1)
|
|
// test-timer: 5s ()
|
|
}
|