mirror of
https://github.com/hanzoai/tasks.git
synced 2026-10-04 02:04:03 +00:00
LuanandGitHub
ea53aa9362
## What changed?
Using the new metricDefinition.With approach.
## Why?
The usage of 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
```
And using the new With(Handler) method, there's no need to specify
redundant information.
## How did you test it?
Already exists an ExampleHandler which tests all the new approach
methods.
## Potential risks
People can still use the old approach, because we are keeping
the Handler interface as-is.
## Is hotfix candidate?
No.
57 lines
2.2 KiB
Go
57 lines
2.2 KiB
Go
// The MIT License
|
|
|
|
//
|
|
// Copyright (c) 2023 Temporal Technologies Inc. All rights reserved.
|
|
//
|
|
// Copyright (c) 2023 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
|
|
|
|
import (
|
|
"fmt"
|
|
"runtime/debug"
|
|
|
|
"go.temporal.io/api/serviceerror"
|
|
"go.temporal.io/server/common/log"
|
|
"go.temporal.io/server/common/log/tag"
|
|
)
|
|
|
|
// CapturePanic is used to capture panic, it will emit the service panic metric, log the panic and also return the error through pointer.
|
|
// If the panic value is not error then a default error is returned
|
|
// We have to use pointer is because in golang: "recover return nil if was not called directly by a deferred function."
|
|
// And we have to set the returned error otherwise our handler will return nil as error which is incorrect
|
|
func CapturePanic(logger log.Logger, metricHandler Handler, retError *error) {
|
|
//revive:disable-next-line:defer
|
|
if panicObj := recover(); panicObj != nil {
|
|
err, ok := panicObj.(error)
|
|
if !ok {
|
|
err = serviceerror.NewInternal(fmt.Sprintf("panic: %v", panicObj))
|
|
}
|
|
|
|
st := string(debug.Stack())
|
|
|
|
logger.Error("Panic is captured", tag.SysStackTrace(st), tag.Error(err))
|
|
|
|
ServicePanic.With(metricHandler).Record(1)
|
|
*retError = serviceerror.NewInternal(err.Error())
|
|
}
|
|
}
|