When to use errors.WithStack(err) in the code?

[carlisia]

In the code guidelines here: https://velero.io/docs/v1.5/code-standards/#code it says:

Wrap/add a stack only to errors that are being directly returned from non-velero code, such as an API call to the Kubernetes server.

Can this be clarified?

For example, I would think the error below would qualify to be logged with stack, but as we can see from the output of the log message when using with/without stack it is the same:

velero/pkg/controller/backup_sync_controller.go

Line 182 in 3286834

log.WithError(err).Error("Error listing backups in backup store")

[nrb]

I interpret the documentation to mean "Any Go package that is not within the Velero codebase, including standard library, should be returned with errors.WithStack."

Other functions like errrors.Wrap actually do WithStack under the hood, if I remember correctly.