From a5dbcc756c9a2fa9bafac6fb91bbbc5c372fcd28 Mon Sep 17 00:00:00 2001 From: Toby Date: Mon, 18 Jul 2016 16:36:46 +0100 Subject: [PATCH 1/5] Renaming 'Sirupsen' to 'sirupsen' --- doc.go | 4 ++-- examples/basic/basic.go | 2 +- examples/hook/hook.go | 5 +---- hooks/syslog/syslog.go | 3 ++- hooks/syslog/syslog_test.go | 3 ++- hooks/test/test.go | 2 +- hooks/test/test_test.go | 2 +- json_formatter.go | 2 +- 8 files changed, 11 insertions(+), 12 deletions(-) diff --git a/doc.go b/doc.go index dddd5f8..da67aba 100644 --- a/doc.go +++ b/doc.go @@ -7,7 +7,7 @@ The simplest way to use Logrus is simply the package-level exported logger: package main import ( - log "github.com/Sirupsen/logrus" + log "github.com/sirupsen/logrus" ) func main() { @@ -21,6 +21,6 @@ The simplest way to use Logrus is simply the package-level exported logger: Output: time="2015-09-07T08:48:33Z" level=info msg="A walrus appears" animal=walrus number=1 size=10 -For a full guide visit https://github.com/Sirupsen/logrus +For a full guide visit https://github.com/sirupsen/logrus */ package logrus diff --git a/examples/basic/basic.go b/examples/basic/basic.go index a1623ec..b22468d 100644 --- a/examples/basic/basic.go +++ b/examples/basic/basic.go @@ -1,7 +1,7 @@ package main import ( - "github.com/Sirupsen/logrus" + "github.com/sirupsen/logrus" ) var log = logrus.New() diff --git a/examples/hook/hook.go b/examples/hook/hook.go index 3187f6d..892b231 100644 --- a/examples/hook/hook.go +++ b/examples/hook/hook.go @@ -1,9 +1,6 @@ package main -import ( - "github.com/Sirupsen/logrus" - "gopkg.in/gemnasium/logrus-airbrake-hook.v2" -) +import "github.com/sirupsen/logrus" var log = logrus.New() diff --git a/hooks/syslog/syslog.go b/hooks/syslog/syslog.go index a36e200..fef9804 100644 --- a/hooks/syslog/syslog.go +++ b/hooks/syslog/syslog.go @@ -4,9 +4,10 @@ package logrus_syslog import ( "fmt" - "github.com/Sirupsen/logrus" "log/syslog" "os" + + "github.com/sirupsen/logrus" ) // SyslogHook to send logs via syslog. diff --git a/hooks/syslog/syslog_test.go b/hooks/syslog/syslog_test.go index 42762dc..89bd1ec 100644 --- a/hooks/syslog/syslog_test.go +++ b/hooks/syslog/syslog_test.go @@ -1,9 +1,10 @@ package logrus_syslog import ( - "github.com/Sirupsen/logrus" "log/syslog" "testing" + + "github.com/sirupsen/logrus" ) func TestLocalhostAddAndPrint(t *testing.T) { diff --git a/hooks/test/test.go b/hooks/test/test.go index 0688125..48c06ab 100644 --- a/hooks/test/test.go +++ b/hooks/test/test.go @@ -3,7 +3,7 @@ package test import ( "io/ioutil" - "github.com/Sirupsen/logrus" + "github.com/sirupsen/logrus" ) // test.Hook is a hook designed for dealing with logs in test scenarios. diff --git a/hooks/test/test_test.go b/hooks/test/test_test.go index d69455b..3f55cfe 100644 --- a/hooks/test/test_test.go +++ b/hooks/test/test_test.go @@ -3,7 +3,7 @@ package test import ( "testing" - "github.com/Sirupsen/logrus" + "github.com/sirupsen/logrus" "github.com/stretchr/testify/assert" ) diff --git a/json_formatter.go b/json_formatter.go index 2ad6dc5..47da504 100644 --- a/json_formatter.go +++ b/json_formatter.go @@ -16,7 +16,7 @@ func (f *JSONFormatter) Format(entry *Entry) ([]byte, error) { switch v := v.(type) { case error: // Otherwise errors are ignored by `encoding/json` - // https://github.com/Sirupsen/logrus/issues/137 + // https://github.com/sirupsen/logrus/issues/137 data[k] = v.Error() default: data[k] = v From ed63efede8fb241e8cb6489c179c497b8a845519 Mon Sep 17 00:00:00 2001 From: Toby Date: Wed, 27 Jul 2016 13:00:56 +0100 Subject: [PATCH 2/5] re-adding airbrake import --- examples/hook/hook.go | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/examples/hook/hook.go b/examples/hook/hook.go index 892b231..04e08f4 100644 --- a/examples/hook/hook.go +++ b/examples/hook/hook.go @@ -1,6 +1,9 @@ package main -import "github.com/sirupsen/logrus" +import ( + "github.com/sirupsen/logrus" + airbrake "gopkg.in/gemnasium/logrus-airbrake-hook.v2" +) var log = logrus.New() From c8b0c0e43b04fa5af90bddaff775cbd8d6fec7d5 Mon Sep 17 00:00:00 2001 From: Toby Date: Wed, 27 Jul 2016 13:12:26 +0100 Subject: [PATCH 3/5] Fixing import for airbrake and adding build constraint to example hook --- README.md | 18 +++++++++--------- alt_exit_test.go | 2 +- examples/hook/hook.go | 6 ++++++ hooks/syslog/README.md | 10 +++++----- 4 files changed, 21 insertions(+), 15 deletions(-) diff --git a/README.md b/README.md index f8302c3..8ce5db9 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Logrus :walrus: [![Build Status](https://travis-ci.org/Sirupsen/logrus.svg?branch=master)](https://travis-ci.org/Sirupsen/logrus) [![GoDoc](https://godoc.org/github.com/Sirupsen/logrus?status.svg)](https://godoc.org/github.com/Sirupsen/logrus) +# Logrus :walrus: [![Build Status](https://travis-ci.org/sirupsen/logrus.svg?branch=master)](https://travis-ci.org/sirupsen/logrus) [![GoDoc](https://godoc.org/github.com/sirupsen/logrus?status.svg)](https://godoc.org/github.com/sirupsen/logrus) Logrus is a structured logger for Go (golang), completely API compatible with the standard library logger. [Godoc][godoc]. **Please note the Logrus API is not @@ -54,7 +54,7 @@ The simplest way to use Logrus is simply the package-level exported logger: package main import ( - log "github.com/Sirupsen/logrus" + log "github.com/sirupsen/logrus" ) func main() { @@ -65,7 +65,7 @@ func main() { ``` Note that it's completely api-compatible with the stdlib logger, so you can -replace your `log` imports everywhere with `log "github.com/Sirupsen/logrus"` +replace your `log` imports everywhere with `log "github.com/sirupsen/logrus"` and you'll now have the flexibility of Logrus. You can customize it all you want: @@ -74,7 +74,7 @@ package main import ( "os" - log "github.com/Sirupsen/logrus" + log "github.com/sirupsen/logrus" ) func init() { @@ -123,7 +123,7 @@ application, you can also create an instance of the `logrus` Logger: package main import ( - "github.com/Sirupsen/logrus" + "github.com/sirupsen/logrus" ) // Create a new instance of the logger. You can have any number of instances. @@ -176,9 +176,9 @@ Logrus comes with [built-in hooks](hooks/). Add those, or your custom hook, in ```go import ( - log "github.com/Sirupsen/logrus" + log "github.com/sirupsen/logrus" "gopkg.in/gemnasium/logrus-airbrake-hook.v2" // the package is named "aibrake" - logrus_syslog "github.com/Sirupsen/logrus/hooks/syslog" + logrus_syslog "github.com/sirupsen/logrus/hooks/syslog" "log/syslog" ) @@ -203,7 +203,7 @@ Note: Syslog hook also support connecting to local syslog (Ex. "/dev/log" or "/v | [Airbrake](https://github.com/gemnasium/logrus-airbrake-hook) | Send errors to the Airbrake API V3. Uses the official [`gobrake`](https://github.com/airbrake/gobrake) behind the scenes. | | [Airbrake "legacy"](https://github.com/gemnasium/logrus-airbrake-legacy-hook) | Send errors to an exception tracking service compatible with the Airbrake API V2. Uses [`airbrake-go`](https://github.com/tobi/airbrake-go) behind the scenes. | | [Papertrail](https://github.com/polds/logrus-papertrail-hook) | Send errors to the [Papertrail](https://papertrailapp.com) hosted logging service via UDP. | -| [Syslog](https://github.com/Sirupsen/logrus/blob/master/hooks/syslog/syslog.go) | Send errors to remote syslog server. Uses standard library `log/syslog` behind the scenes. | +| [Syslog](https://github.com/sirupsen/logrus/blob/master/hooks/syslog/syslog.go) | Send errors to remote syslog server. Uses standard library `log/syslog` behind the scenes. | | [Bugsnag](https://github.com/Shopify/logrus-bugsnag/blob/master/bugsnag.go) | Send errors to the Bugsnag exception tracking service. | | [Sentry](https://github.com/evalphobia/logrus_sentry) | Send errors to the Sentry error logging and aggregation service. | | [Hiprus](https://github.com/nubo/hiprus) | Send errors to a channel in hipchat. | @@ -277,7 +277,7 @@ could do: ```go import ( - log "github.com/Sirupsen/logrus" + log "github.com/sirupsen/logrus" ) init() { diff --git a/alt_exit_test.go b/alt_exit_test.go index 022b778..d182963 100644 --- a/alt_exit_test.go +++ b/alt_exit_test.go @@ -44,7 +44,7 @@ var testprog = []byte(` package main import ( - "github.com/Sirupsen/logrus" + "github.com/sirupsen/logrus" "flag" "fmt" "io/ioutil" diff --git a/examples/hook/hook.go b/examples/hook/hook.go index 04e08f4..91b41ee 100644 --- a/examples/hook/hook.go +++ b/examples/hook/hook.go @@ -1,3 +1,9 @@ +// +build ignore +// Do NOT include the above line in your code. This is a build contrainst used +// to prevent import loops in the code whilst go get'ting it. +// Read more about build contrains in golang here: +// https://golang.org/pkg/go/build/#hdr-Build_Constraints + package main import ( diff --git a/hooks/syslog/README.md b/hooks/syslog/README.md index 066704b..92b391c 100644 --- a/hooks/syslog/README.md +++ b/hooks/syslog/README.md @@ -5,8 +5,8 @@ ```go import ( "log/syslog" - "github.com/Sirupsen/logrus" - logrus_syslog "github.com/Sirupsen/logrus/hooks/syslog" + "github.com/sirupsen/logrus" + logrus_syslog "github.com/sirupsen/logrus/hooks/syslog" ) func main() { @@ -24,8 +24,8 @@ If you want to connect to local syslog (Ex. "/dev/log" or "/var/run/syslog" or " ```go import ( "log/syslog" - "github.com/Sirupsen/logrus" - logrus_syslog "github.com/Sirupsen/logrus/hooks/syslog" + "github.com/sirupsen/logrus" + logrus_syslog "github.com/sirupsen/logrus/hooks/syslog" ) func main() { @@ -36,4 +36,4 @@ func main() { log.Hooks.Add(hook) } } -``` \ No newline at end of file +``` From 2e779aca86f47cc5e073e555b50ea876423c371c Mon Sep 17 00:00:00 2001 From: Toby Date: Tue, 16 Aug 2016 17:04:58 +0100 Subject: [PATCH 4/5] Correcting typos --- examples/hook/hook.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/examples/hook/hook.go b/examples/hook/hook.go index 91b41ee..707a5bb 100644 --- a/examples/hook/hook.go +++ b/examples/hook/hook.go @@ -1,7 +1,7 @@ // +build ignore -// Do NOT include the above line in your code. This is a build contrainst used +// Do NOT include the above line in your code. This is a build constraint used // to prevent import loops in the code whilst go get'ting it. -// Read more about build contrains in golang here: +// Read more about build constraints in golang here: // https://golang.org/pkg/go/build/#hdr-Build_Constraints package main From 90915c932628aa7dcf3d926b4370c72b23bcdbb6 Mon Sep 17 00:00:00 2001 From: Daniel Taylor Date: Tue, 29 Nov 2016 10:52:28 -0800 Subject: [PATCH 5/5] Fix typo in README --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index f9cfb0a..ed1b140 100644 --- a/README.md +++ b/README.md @@ -408,7 +408,7 @@ logrus.RegisterExitHandler(handler) ... ``` -#### Thread safty +#### Thread safety By default Logger is protected by mutex for concurrent writes, this mutex is invoked when calling hooks and writing logs. If you are sure such locking is not needed, you can call logger.SetNoLock() to disable the locking.