github.com/cockroachdb/cockroach@v20.2.0-alpha.1+incompatible/pkg/server/api_error.go (about)

     1  // Copyright 2017 The Cockroach Authors.
     2  //
     3  // Use of this software is governed by the Business Source License
     4  // included in the file licenses/BSL.txt.
     5  //
     6  // As of the Change Date specified in that file, in accordance with
     7  // the Business Source License, use of this software will be governed
     8  // by the Apache License, Version 2.0, included in the file
     9  // licenses/APL.txt.
    10  
    11  package server
    12  
    13  import (
    14  	"context"
    15  
    16  	"github.com/cockroachdb/cockroach/pkg/util/log"
    17  	"google.golang.org/grpc/codes"
    18  	"google.golang.org/grpc/status"
    19  )
    20  
    21  var errAPIInternalError = status.Errorf(
    22  	codes.Internal,
    23  	"An internal server error has occurred. Please check your CockroachDB logs for more details.",
    24  )
    25  
    26  // apiInternalError should be used to wrap server-side errors during API
    27  // requests. This method records the contents of the error to the server log,
    28  // and returns a standard GRPC error which is appropriate to return to the
    29  // client.
    30  func apiInternalError(ctx context.Context, err error) error {
    31  	log.ErrorfDepth(ctx, 1, "%s", err)
    32  	return errAPIInternalError
    33  }