go.temporal.io/server@v1.23.0/common/metrics/panic.go (about)

     1  // The MIT License
     2  
     3  //
     4  // Copyright (c) 2023 Temporal Technologies Inc.  All rights reserved.
     5  //
     6  // Copyright (c) 2023 Uber Technologies, Inc.
     7  //
     8  // Permission is hereby granted, free of charge, to any person obtaining a copy
     9  // of this software and associated documentation files (the "Software"), to deal
    10  // in the Software without restriction, including without limitation the rights
    11  // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
    12  // copies of the Software, and to permit persons to whom the Software is
    13  // furnished to do so, subject to the following conditions:
    14  //
    15  // The above copyright notice and this permission notice shall be included in
    16  // all copies or substantial portions of the Software.
    17  //
    18  // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
    19  // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
    20  // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
    21  // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
    22  // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
    23  // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
    24  // THE SOFTWARE.
    25  
    26  package metrics
    27  
    28  import (
    29  	"fmt"
    30  	"runtime/debug"
    31  
    32  	"go.temporal.io/api/serviceerror"
    33  	"go.temporal.io/server/common/log"
    34  	"go.temporal.io/server/common/log/tag"
    35  )
    36  
    37  // CapturePanic is used to capture panic, it will emit the service panic metric, log the panic and also return the error through pointer.
    38  // If the panic value is not error then a default error is returned
    39  // We have to use pointer is because in golang: "recover return nil if was not called directly by a deferred function."
    40  // And we have to set the returned error otherwise our handler will return nil as error which is incorrect
    41  func CapturePanic(logger log.Logger, metricHandler Handler, retError *error) {
    42  	//revive:disable-next-line:defer
    43  	if panicObj := recover(); panicObj != nil {
    44  		err, ok := panicObj.(error)
    45  		if !ok {
    46  			err = serviceerror.NewInternal(fmt.Sprintf("panic: %v", panicObj))
    47  		}
    48  
    49  		st := string(debug.Stack())
    50  
    51  		logger.Error("Panic is captured", tag.SysStackTrace(st), tag.Error(err))
    52  
    53  		metricHandler.Counter(ServicePanic.Name()).Record(1)
    54  		*retError = serviceerror.NewInternal(err.Error())
    55  	}
    56  }