Add HipChat log handler

- Added some goods for all handlers.
- Updated all handlers to have a buffer of 3 and 3 workers by default.

Author: joeybloggs

README.md

@@ -1,6 +1,6 @@
 ## log
 <img align="right" src="https://raw.githubusercontent.com/go-playground/log/master/logo.png">
-![Project status](https://img.shields.io/badge/version-3.0.1-green.svg)
+![Project status](https://img.shields.io/badge/version-3.1.0-green.svg)
 [![Build Status](https://semaphoreci.com/api/v1/joeybloggs/log/branches/master/badge.svg)](https://semaphoreci.com/joeybloggs/log)
 [![Coverage Status](https://coveralls.io/repos/github/go-playground/log/badge.svg?branch=master)](https://coveralls.io/github/go-playground/log?branch=master)
 [![Go Report Card](https://goreportcard.com/badge/github.com/go-playground/log)](https://goreportcard.com/report/github.com/go-playground/log)

handlers/console/console.go

@@ -59,8 +59,8 @@ var defaultColors = [...]log.ANSIEscSeq{
 // New returns a new instance of the console logger
 func New() *Console {
 	return &Console{
-		buffer:          0,
-		numWorkers:      1,
+		buffer:          3,
+		numWorkers:      3,
 		colors:          defaultColors,
 		writer:          os.Stderr,
 		timestampFormat: log.DefaultTimeFormat,

handlers/console/doc.go

@@ -0,0 +1,37 @@
+/*
+Package console allows for log messages to be sent to a any writer, default os.Stderr.
+
+Example
+
+simple console
+
+	package main
+
+    import (
+        "github.com/go-playground/log"
+        "github.com/go-playground/log/handlers/console"
+    )
+
+    func main() {
+
+        cLog := console.New()
+
+        log.RegisterHandler(cLog, log.AllLevels...)
+
+        // Trace
+        defer log.Trace("trace").End()
+
+        log.Debug("debug")
+        log.Info("info")
+        log.Notice("notice")
+        log.Warn("warn")
+        log.Error("error")
+        // log.Panic("panic") // this will panic
+        log.Alert("alert")
+        // log.Fatal("fatal") // this will call os.Exit(1)
+
+        // logging with fields can be used with any of the above
+        log.WithFields(log.F("key", "value")).Info("test info")
+    }
+*/
+package console

handlers/email/doc.go

@@ -0,0 +1,25 @@
+/*
+Package email allows for log messages to be sent via email.
+
+Example
+
+simple email
+
+    package main
+
+    import (
+        "github.com/go-playground/log"
+        "github.com/go-playground/log/handlers/email"
+    )
+
+    func main() {
+
+        email := email.New("smtp.gmail.com", 587, "username", "password", "[email protected]", []string{"[email protected]"})
+        email.SetFilenameDisplay(log.Llongfile)
+
+        log.RegisterHandler(email, log.WarnLevel, log.AlertLevel, log.PanicLevel)
+
+        log.WithFields(log.F("error", "something went wrong")).StackTrace().Alert("ALERT!")
+    }
+*/
+package email

handlers/email/email.go

@@ -65,8 +65,8 @@ type Email struct {
 func New(host string, port int, username string, password string, from string, to []string) *Email {
 
 	return &Email{
-		buffer:          0,
-		numWorkers:      1,
+		buffer:          3,
+		numWorkers:      3,
 		timestampFormat: log.DefaultTimeFormat,
 		fileDisplay:     log.Lshortfile,
 		templateHTML:    defaultTemplate,

handlers/http/doc.go

@@ -0,0 +1,47 @@
+/*
+Package http allows for log messages to be sent via http.
+
+Example
+
+NOTE: you can use the HTTP handler as a base for creating other handlers
+
+    package main
+
+    import (
+        stdhttp "net/http"
+
+        "github.com/go-playground/log"
+        "github.com/go-playground/log/handlers/http"
+    )
+
+    func main() {
+
+        header := make(stdhttp.Header)
+        header.Set("Authorization", "Bearer 378978HJJFEWj73JENEWFN3475")
+
+        h, err := http.New("https://logs.logserver.com:4565", "POST", header)
+        if err != nil {
+            // handle error, most likely URL parsing error
+        }
+
+        h.SetFilenameDisplay(log.Llongfile)
+
+        log.RegisterHandler(h, log.AllLevels...)
+
+        // Trace
+        defer log.Trace("trace").End()
+
+        log.Debug("debug")
+        log.Info("info")
+        log.Notice("notice")
+        log.Warn("warn")
+        log.Error("error")
+        // log.Panic("panic") // this will panic
+        log.Alert("alert")
+        // log.Fatal("fatal") // this will call os.Exit(1)
+
+        // logging with fields can be used with any of the above
+        log.WithFields(log.F("key", "value")).Info("test info")
+    }
+*/
+package http

handlers/http/hipchat/doc.go

@@ -0,0 +1,29 @@
+/*
+Package hipchat allows for log messages to be sent to a hipchat room.
+
+Example
+
+NOTE: "/notification" is added to the host url automatically.
+
+	package main
+
+	import (
+		"github.com/go-playground/log"
+		"github.com/go-playground/log/handlers/http/hipchat"
+	)
+
+	func main() {
+
+		// NOTE: ROOM TOKEN must have view permissions for room
+		hc, err := hipchat.New(hipchat.APIv2, "https://api.hipchat.com/v2/room/{ROOM ID or NAME}", "application/json", "{ROOM TOKEN}")
+		if err != nil {
+			log.Error(err)
+		}
+		hc.SetFilenameDisplay(log.Llongfile)
+
+		log.RegisterHandler(hc, log.WarnLevel, log.AlertLevel, log.PanicLevel)
+
+		log.WithFields(log.F("error", "something went wrong")).StackTrace().Alert("ALERT!")
+	}
+*/
+package hipchat