feat: Add error logging in the handler (#6)

* feat: Add error logging in the handler

* fix: Use quay.io references instead of docker.io ones

* fix: logger error in tests

Co-authored-by: Néstor Salceda <[email protected]>

Author: airadier

cmd/harbor-scanner-sysdig-secure/main.go

@@ -31,7 +31,7 @@ func main() {
 	log.SetLevel(log.TraceLevel)
 	log.Info("Starting harbor-scanner-sysdig-secure")
 
-	apiHandler := v1.NewAPIHandler(getAdapter(), log.StandardLogger().Writer())
+	apiHandler := v1.NewAPIHandler(getAdapter(), log.StandardLogger())
 
 	apiServer := api.NewServer(apiHandler)
 

pkg/http/api/v1/handler.go

@@ -5,6 +5,7 @@ import (
 	"fmt"
 	"io"
 	"net/http"
+	"time"
 
 	"github.com/gorilla/handlers"
 	"github.com/gorilla/mux"
@@ -15,11 +16,19 @@ import (
 
 type requestHandler struct {
 	adapter scanner.Adapter
+	logger Logger
 }
 
-func NewAPIHandler(adapter scanner.Adapter, logger io.Writer) http.Handler {
+type Logger interface {
+	Writer() *io.PipeWriter
+	Error(args ...interface{})
+	Errorf(format string, args ...interface{})
+}
+
+func NewAPIHandler(adapter scanner.Adapter, logger Logger) http.Handler {
 	handler := requestHandler{
 		adapter: adapter,
+		logger: logger,
 	}
 
 	router := mux.NewRouter()
@@ -30,7 +39,7 @@ func NewAPIHandler(adapter scanner.Adapter, logger io.Writer) http.Handler {
 	apiV1Router.Methods(http.MethodPost).Path("/scan").HandlerFunc(handler.scan)
 	apiV1Router.Methods(http.MethodGet).Path("/scan/{scan_request_id}/report").HandlerFunc(handler.getReport)
 
-	return handlers.LoggingHandler(logger, router)
+	return handlers.LoggingHandler(logger.Writer(), router)
 }
 
 func health(res http.ResponseWriter, req *http.Request) {
@@ -40,8 +49,10 @@ func health(res http.ResponseWriter, req *http.Request) {
 func (h *requestHandler) metadata(res http.ResponseWriter, req *http.Request) {
 	metadata, err := h.adapter.GetMetadata()
 	if err != nil {
+		h.logRequestError(req, err)
 		res.Header().Set("Content-Type", harbor.ScanAdapterErrorMimeType)
 		res.WriteHeader(http.StatusInternalServerError)
+
 		json.NewEncoder(res).Encode(errorResponseFromError(err))
 		return
 	}
@@ -100,6 +111,16 @@ func (h *requestHandler) getReport(res http.ResponseWriter, req *http.Request) {
 	json.NewEncoder(res).Encode(vulnerabilityReport)
 }
 
+func (h *requestHandler) logRequestError(req *http.Request, err error) {
+	ts := time.Now()
+	h.logger.Errorf("[%s] \"%s %s %s\" request ERROR: %s",
+		ts.Format("02/Jan/2006:15:04:05 -0700"),
+		req.Method,
+		req.RequestURI,
+		req.Proto,
+		err)
+}
+
 func errorResponseFromError(err error) harbor.ErrorResponse {
 	return harbor.ErrorResponse{
 		Error: &harbor.ModelError{

pkg/http/api/v1/handler_test.go

@@ -3,6 +3,7 @@ package v1_test
 import (
 	"encoding/json"
 	"errors"
+	log "github.com/sirupsen/logrus"
 	"net/http"
 	"net/http/httptest"
 	"strings"
@@ -31,7 +32,9 @@ var _ = Describe("Harbor Scanner Sysdig Secure API Adapter", func() {
 	BeforeEach(func() {
 		controller = gomock.NewController(GinkgoT())
 		adapter = mocks.NewMockAdapter(controller)
-		handler = v1.NewAPIHandler(adapter, GinkgoWriter)
+		log.SetOutput(GinkgoWriter)
+		log.SetLevel(log.TraceLevel)
+		handler = v1.NewAPIHandler(adapter, log.StandardLogger())
 	})
 
 	AfterEach(func() {

pkg/secure/client_test.go

@@ -25,7 +25,7 @@ var _ = Describe("Sysdig Secure Client", func() {
 
 	Context("when adding an image to scanning queue", func() {
 		It("adds image to scanning queue", func() {
-			response, _ := client.AddImage("sysdig/agent:9.8.0", false)
+			response, _ := client.AddImage("quay.io/sysdig/agent:10.6.0", false)
 
 			Expect(response).NotTo(Equal(secure.ScanResponse{}))
 			Expect(response.ImageContent).NotTo(BeNil())
@@ -58,7 +58,7 @@ var _ = Describe("Sysdig Secure Client", func() {
 			})
 
 			It("returns a ReportNotReadyErr if the image is being analyzed", func() {
-				response, _ := client.AddImage("sysdig/agent:9.9.0", true)
+				response, _ := client.AddImage("quay.io/sysdig/agent:10.7.0", true)
 
 				_, err := client.GetVulnerabilities(response.ImageDigest)