Mobile (#735)

Initial modification to support mobile client

Export necessary interfaces for Android framework

formatter/formatter.go

@@ -10,15 +10,15 @@ import (
 
 // TextFormatter formats logs into text with included source code's path
 type TextFormatter struct {
-	TimestampFormat string
-	LevelDesc       []string
+	timestampFormat string
+	levelDesc       []string
 }
 
 // NewTextFormatter create new MyTextFormatter instance
 func NewTextFormatter() *TextFormatter {
 	return &TextFormatter{
-		LevelDesc:       []string{"PANC", "FATL", "ERRO", "WARN", "INFO", "DEBG", "TRAC"},
-		TimestampFormat: time.RFC3339, // or RFC3339
+		levelDesc:       []string{"PANC", "FATL", "ERRO", "WARN", "INFO", "DEBG", "TRAC"},
+		timestampFormat: time.RFC3339, // or RFC3339
 	}
 }
 
@@ -39,13 +39,13 @@ func (f *TextFormatter) Format(entry *logrus.Entry) ([]byte, error) {
 
 	level := f.parseLevel(entry.Level)
 
-	return []byte(fmt.Sprintf("%s %s %s%s: %s\n", entry.Time.Format(f.TimestampFormat), level, fields, entry.Data["source"], entry.Message)), nil
+	return []byte(fmt.Sprintf("%s %s %s%s: %s\n", entry.Time.Format(f.timestampFormat), level, fields, entry.Data["source"], entry.Message)), nil
 }
 
 func (f *TextFormatter) parseLevel(level logrus.Level) string {
-	if len(f.LevelDesc) < int(level) {
+	if len(f.levelDesc) < int(level) {
 		return ""
 	}
 
-	return f.LevelDesc[level]
+	return f.levelDesc[level]
 }

formatter/logcat.go

@@ -0,0 +1,48 @@
+package formatter
+
+import (
+	"fmt"
+	"strings"
+
+	"github.com/sirupsen/logrus"
+)
+
+// LogcatFormatter formats logs into text what is fit for logcat
+type LogcatFormatter struct {
+	levelDesc []string
+}
+
+// NewLogcatFormatter create new LogcatFormatter instance
+func NewLogcatFormatter() *LogcatFormatter {
+	return &LogcatFormatter{
+		levelDesc: []string{"PANC", "FATL", "ERRO", "WARN", "INFO", "DEBG", "TRAC"},
+	}
+}
+
+// Format renders a single log entry
+func (f *LogcatFormatter) Format(entry *logrus.Entry) ([]byte, error) {
+	var fields string
+	keys := make([]string, 0, len(entry.Data))
+	for k, v := range entry.Data {
+		if k == "source" {
+			continue
+		}
+		keys = append(keys, fmt.Sprintf("%s: %v", k, v))
+	}
+
+	if len(keys) > 0 {
+		fields = fmt.Sprintf("[%s] ", strings.Join(keys, ", "))
+	}
+
+	level := f.parseLevel(entry.Level)
+
+	return []byte(fmt.Sprintf("[%s] %s%s %s\n", level, fields, entry.Data["source"], entry.Message)), nil
+}
+
+func (f *LogcatFormatter) parseLevel(level logrus.Level) string {
+	if len(f.levelDesc) < int(level) {
+		return ""
+	}
+
+	return f.levelDesc[level]
+}

formatter/logcat_test.go

@@ -0,0 +1,28 @@
+package formatter
+
+import (
+	"testing"
+	"time"
+
+	"github.com/sirupsen/logrus"
+)
+
+func TestLogcatMessageFormat(t *testing.T) {
+
+	someEntry := &logrus.Entry{
+		Data:    logrus.Fields{"att1": 1, "att2": 2, "source": "some/fancy/path.go:46"},
+		Time:    time.Date(2021, time.Month(2), 21, 1, 10, 30, 0, time.UTC),
+		Level:   3,
+		Message: "Some Message",
+	}
+
+	formatter := NewLogcatFormatter()
+	result, _ := formatter.Format(someEntry)
+
+	expectedString := "[WARN] [att1: 1, att2: 2] some/fancy/path.go:46 Some Message\n"
+	expectedStringVariant := "[WARN] [att2: 2, att1: 1] some/fancy/path.go:46 Some Message\n"
+	parsedString := string(result)
+	if parsedString != expectedString && parsedString != expectedStringVariant {
+		t.Errorf("The log messages don't match. Expected: '%s', got: '%s'", expectedString, parsedString)
+	}
+}

formatter/set.go

@@ -2,9 +2,16 @@ package formatter
 
 import "github.com/sirupsen/logrus"
 
-// SetTextFormatter set the formatter for given logger.
+// SetTextFormatter set the text formatter for given logger.
 func SetTextFormatter(logger *logrus.Logger) {
 	logger.Formatter = NewTextFormatter()
 	logger.ReportCaller = true
 	logger.AddHook(NewContextHook())
 }
+
+// SetLogcatFormatter set the logcat formatter for given logger.
+func SetLogcatFormatter(logger *logrus.Logger) {
+	logger.Formatter = NewLogcatFormatter()
+	logger.ReportCaller = true
+	logger.AddHook(NewContextHook())
+}