Merge pull request #267 from carlosms/go-log

Use go-log lib

Author: carlosms

Gopkg.lock

@@ -26,7 +26,7 @@ COMPOSE := docker-compose
 GO_BINDATA_TAG := bindata
 
 # Environment and arguments to use in `go run` calls.
-GO_RUN_ENV := GITBASEPG_ENV=dev
+GO_RUN_ENV := LOG_LEVEL=DEBUG
 GO_RUN_ARGS += -tags "$(GO_BINDATA_TAG)"
 
 GORUN = $(GOCMD) run $(GO_RUN_ARGS)

Makefile

@@ -77,9 +77,13 @@ Any of the previous execution methods accept configuration through the following
 | `GITBASEPG_SERVER_URL` | `--server` | | URL used to access the application in the form `HOSTNAME[:PORT]`. Leave it unset to allow connections from any proxy or public address |
 | `GITBASEPG_DB_CONNECTION` | `--db` | `root@tcp(localhost:3306)/none?maxAllowedPacket=4194304` | gitbase connection string. Use the DSN (Data Source Name) format described in the [Go MySQL Driver docs](https://github.com/go-sql-driver/mysql#dsn-data-source-name). |
 | `GITBASEPG_BBLFSH_SERVER_URL` | `--bblfsh` | `127.0.0.1:9432` | Address where bblfsh server is listening |
-| `GITBASEPG_ENV` | `--env` | `production` | Sets the log level. Use `dev` to enable debug log messages |
 | `GITBASEPG_SELECT_LIMIT` | `--select-limit` | `100` | Default `LIMIT` forced on all the SQL queries done from the UI. Set it to 0 to remove any limit |
 | `GITBASEPG_FOOTER_HTML` | `--footer` | | Allows to add any custom html to the page footer. It must be a string encoded in base64. Use it, for example, to add your analytics tracking code snippet  |
+| `LOG_LEVEL` | `--log-level=`  | `info` | Logging level (`info`, `debug`, `warning` or `error`) |
+| `LOG_FORMAT` | `--log-format=`  |  | log format (`text` or `json`), defaults to `text` on a terminal and `json` otherwise |
+| `LOG_FIELDS` | `--log-fields=`  |  | default fields for the logger, specified in json |
+| `LOG_FORCE_FORMAT` | `--log-force-format` | | ignore if it is running on a terminal or not |
+
 
 # Contribute
 

README.md

@@ -2,15 +2,17 @@ package main
 
 import (
 	"database/sql"
+	"encoding/json"
 	"fmt"
 	"net/http"
 
+	"github.com/sirupsen/logrus"
 	"github.com/src-d/gitbase-web/server"
 	"github.com/src-d/gitbase-web/server/handler"
-	"github.com/src-d/gitbase-web/server/service"
 
 	_ "github.com/go-sql-driver/mysql"
 	"gopkg.in/src-d/go-cli.v0"
+	"gopkg.in/src-d/go-log.v1"
 )
 
 // version will be replaced automatically by the CI build.
@@ -30,7 +32,7 @@ var app = cli.New(name, version, build, "gitbase web client")
 // https://github.com/go-sql-driver/mysql/pull/680
 type ServeCommand struct {
 	cli.PlainCommand `name:"serve" short-description:"serve the app" long-description:"starts serving the application"`
-	Env              string `long:"env" env:"GITBASEPG_ENV" default:"production" description:"Sets the log level. Use 'dev' to enable debug log messages"`
+	cli.LogOptions   `group:"Log Options"`
 	Host             string `long:"host" env:"GITBASEPG_HOST" default:"0.0.0.0" description:"IP address to bind the HTTP server"`
 	Port             int    `long:"port" env:"GITBASEPG_PORT" default:"8080" description:"Port to bind the HTTP server"`
 	ServerURL        string `long:"server" env:"GITBASEPG_SERVER_URL" description:"URL used to access the application in the form 'HOSTNAME[:PORT]'. Leave it unset to allow connections from any proxy or public address"`
@@ -41,13 +43,12 @@ type ServeCommand struct {
 }
 
 func (c *ServeCommand) Execute(args []string) error {
-	// logger
-	logger := service.NewLogger(c.Env)
+	c.initLog()
 
 	// database
 	db, err := sql.Open("mysql", c.DBConn)
 	if err != nil {
-		logger.Fatalf("error opening the database: %s", err)
+		return fmt.Errorf("error opening the database: %s", err.Error())
 	}
 	defer db.Close()
 
@@ -56,14 +57,35 @@ func (c *ServeCommand) Execute(args []string) error {
 	static := handler.NewStatic("build/public", c.ServerURL, c.SelectLimit, c.FooterHTML)
 
 	// start the router
-	router := server.Router(logger, static, version, db, c.BblfshServerURL)
-	logger.Infof("listening on %s:%d", c.Host, c.Port)
-	err = http.ListenAndServe(fmt.Sprintf("%s:%d", c.Host, c.Port), router)
-	logger.Fatal(err)
+	router := server.Router(logrus.StandardLogger(), static, version, db, c.BblfshServerURL)
+
+	log.With(log.Fields{"version": version, "build": build}).
+		Infof("listening on %s:%d", c.Host, c.Port)
 
-	return nil
+	err = http.ListenAndServe(fmt.Sprintf("%s:%d", c.Host, c.Port), router)
+	log.Errorf(err, "")
+	return err
 }
 
+func (c *ServeCommand) initLog() {
+	if c.LogFields == "" {
+		bytes, err := json.Marshal(log.Fields{"app": name})
+		if err != nil {
+			panic(err)
+		}
+		c.LogFields = string(bytes)
+	}
+
+	log.DefaultFactory = &log.LoggerFactory{
+		Level:       c.LogLevel,
+		Format:      c.LogFormat,
+		Fields:      c.LogFields,
+		ForceFormat: c.LogForceFormat,
+	}
+	log.DefaultFactory.ApplyToLogrus()
+
+	log.DefaultLogger = log.New(nil)
+}
 func main() {
 	app.AddCommand(&ServeCommand{})
 

cmd/gitbase-web/main.go

@@ -6,7 +6,6 @@ services:
     ports:
       - "8080:8080"
     environment:
-      GITBASEPG_ENV: ${GITBASEPG_ENV}
       GITBASEPG_DB_CONNECTION: root@tcp(gitbase:3306)/none?maxAllowedPacket=4194304
       GITBASEPG_BBLFSH_SERVER_URL: bblfsh:9432
     depends_on:

docker-compose.yml

@@ -88,7 +88,7 @@ Instead of rebuilding the frontend and restarting the backend every time you do
 In one terminal run the Go backend:
 
 ```bash
-$ GITBASEPG_ENV=dev go run cmd/gitbase-web/main.go serve
+$ LOG_LEVEL=DEBUG go run cmd/gitbase-web/main.go serve
 ```
 
 In another terminal, run the frontend:

docs/CONTRIBUTING.md

@@ -11,6 +11,7 @@ import (
 	"strconv"
 	"strings"
 
+	"github.com/pressly/lg"
 	"github.com/src-d/gitbase-web/server/serializer"
 	"github.com/src-d/gitbase-web/server/service"
 
@@ -87,7 +88,7 @@ func Query(db service.SQLDB) RequestProcessFunc {
 		}
 
 		if r.Context().Err() != nil {
-			killQuery(db, query)
+			killQuery(r, db, query)
 			return nil, dbError(r.Context().Err())
 		}
 
@@ -127,10 +128,11 @@ func Query(db service.SQLDB) RequestProcessFunc {
 	}
 }
 
-func killQuery(db service.SQLDB, query string) {
-	pRows, pErr := db.Query("SHOW FULL PROCESSLIST")
+func killQuery(r *http.Request, db service.SQLDB, query string) {
+	const showProcessList = "SHOW FULL PROCESSLIST"
+	pRows, pErr := db.Query(showProcessList)
 	if pErr != nil {
-		// TODO (carlosms) log error when we migrate to go-log
+		lg.RequestLog(r).WithError(pErr).Errorf("failed to execute %q", showProcessList)
 		return
 	}
 	defer pRows.Close()
@@ -146,15 +148,15 @@ func killQuery(db service.SQLDB, query string) {
 		// Id, User, Host, db, Command, Time, State, Info
 		// gitbase returns the query on "Info".
 		if err := pRows.Scan(&id, &rb, &rb, &rb, &rb, &rb, &rb, &info); err != nil {
-			// TODO (carlosms) log error when we migrate to go-log
+			lg.RequestLog(r).WithError(err).Errorf("failed to scan the results of %q", showProcessList)
 			return
 		}
 
 		if info.Valid && info.String == query {
 			if found {
 				// Found more than one match for current query, we cannot know which
 				// one is ours. Skip the cancellation
-				// TODO (carlosms) log error when we migrate to go-log
+				lg.RequestLog(r).Errorf("cannot cancel the query, found more than one match in gitbase")
 				return
 			}