za.co.absa.spline.common.logging.ErrorCode.scala Maven / Gradle / Ivy
/*
* Copyright 2017 ABSA Group Limited
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package za.co.absa.spline.common.logging
import java.util.UUID
import java.util.UUID.randomUUID
import org.slf4s.Logging
/**
*
* An unexpected exception wrapper that is aimed for being sent to a client as a result of a failed operation.
* ErrorCode encapsulates a unique error identifier (UUID) and logs the underlying exception along with that ID,
* so that it is easily identifiable in the logs afterwards (useful for the client support and bug tracing purposes).
*
*
* Usage:
*
*
* Whenever an unexpected operation is occurred during processing any client request, instead of propagating the exception
* to the client or silently logging it and hide from the client, simply create an ErrorCode instance with that exception
* and return it as a response body along with an appropriate response status code (e.g. 500).
*
*
* The underlying exception will be given a unique identifier, logged (via Logger) with that identifier and only the identifier
* will be sent to the client.
*
*/
case class ErrorCode(error_id: UUID)
case object ErrorCode extends Logging {
/**
* Create an ErrorCode instance and log the given exception.
*
* @param e an exception to be tagged and logged
* @return instance of ErrorCode encapsulating a unique identifier with which the given exception was logged.
*/
def apply(e: Throwable): ErrorCode = {
val errorCode = ErrorCode(randomUUID)
log.error(errorCode.toString, e)
errorCode
}
}