Files
Alex SarkesianandGitHub adc4e8a808 Add gocql error handling for persistence storage limit failures. (#6057)
## What changed?
Updated gocql error handling to properly classify persistence errors due
to exceeding space limits on the database.

## Why?
This enables monitoring and observability of errors that occur due to
lack of storage space on the database.

## How did you test it?
Tested locally.

## Potential risks
Invalid classification of database errors.

## Documentation
Validated that no documentation changes are necessary.

## Is hotfix candidate?
No
2024-06-06 20:09:13 -04:00

90 lines
3.3 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 gocql
import (
"context"
"errors"
"fmt"
"strings"
"github.com/gocql/gocql"
enumspb "go.temporal.io/api/enums/v1"
"go.temporal.io/api/serviceerror"
"go.temporal.io/server/common/persistence"
)
func ConvertError(
operation string,
err error,
) error {
if err == nil {
return nil
}
if errors.Is(err, context.DeadlineExceeded) || errors.Is(err, gocql.ErrTimeoutNoResponse) || errors.Is(err, gocql.ErrConnectionClosed) {
return &persistence.TimeoutError{Msg: fmt.Sprintf("operation %v encountered %v", operation, err.Error())}
}
if errors.Is(err, gocql.ErrNotFound) {
return serviceerror.NewNotFound(fmt.Sprintf("operation %v encountered %v", operation, err.Error()))
}
var cqlTimeoutErr gocql.RequestErrWriteTimeout
if errors.As(err, &cqlTimeoutErr) {
return &persistence.TimeoutError{Msg: fmt.Sprintf("operation %v encountered %v", operation, cqlTimeoutErr.Error())}
}
var cqlRequestErr gocql.RequestError
if errors.As(err, &cqlRequestErr) {
if cqlRequestErr.Code() == gocql.ErrCodeOverloaded {
return &serviceerror.ResourceExhausted{
Cause: enumspb.RESOURCE_EXHAUSTED_CAUSE_SYSTEM_OVERLOADED,
Scope: enumspb.RESOURCE_EXHAUSTED_SCOPE_SYSTEM,
Message: fmt.Sprintf("operation %v encountered %v", operation, cqlRequestErr.Error()),
}
}
if cqlRequestErr.Code() == gocql.ErrCodeInvalid {
// NB: See https://cassandra.apache.org/_/blog/Apache-Cassandra-4.1-Features-Guardrails-Framework.html
if strings.Contains(strings.ToLower(cqlRequestErr.Message()), "disk usage exceeds failure threshold") {
return &serviceerror.ResourceExhausted{
Cause: enumspb.RESOURCE_EXHAUSTED_CAUSE_PERSISTENCE_STORAGE_LIMIT,
Scope: enumspb.RESOURCE_EXHAUSTED_SCOPE_SYSTEM,
Message: fmt.Sprintf("operation %v encountered %v", operation, cqlRequestErr.Error()),
}
}
return serviceerror.NewUnavailable(fmt.Sprintf("operation %v encountered %v", operation, cqlRequestErr.Error()))
}
}
return serviceerror.NewUnavailable(fmt.Sprintf("operation %v encountered %v", operation, err.Error()))
}
func IsNotFoundError(err error) bool {
return errors.Is(err, gocql.ErrNotFound)
}