github.com/cockroachdb/cockroachdb-parser@v0.23.3-0.20240213214944-911057d40c9a/pkg/sql/pgwire/pgerror/internal_errors.go (about)

     1  // Copyright 2019 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 pgerror
    12  
    13  import (
    14  	"fmt"
    15  
    16  	"github.com/cockroachdb/errors"
    17  )
    18  
    19  // This file provides facilities to track internal errors.
    20  
    21  // NewInternalTrackingError instantiates an error
    22  // meant for use with telemetry.ReportError directly.
    23  //
    24  // Do not use this! Convert uses to AssertionFailedf or similar
    25  // above.
    26  func NewInternalTrackingError(issue int, detail string) error {
    27  	key := fmt.Sprintf("#%d.%s", issue, detail)
    28  	err := errors.AssertionFailedWithDepthf(1, "%s", errors.Safe(key))
    29  	err = errors.WithTelemetry(err, key)
    30  	err = errors.WithIssueLink(err, errors.IssueLink{IssueURL: fmt.Sprintf("https://github.com/cockroachdb/cockroachdb-parser/issues/%d", issue)})
    31  	return err
    32  }