From 473c3448abc37edc827ade029c8ee302b207b2a6 Mon Sep 17 00:00:00 2001
From: Dave Clendenan <dclendenan@salesforce.com>
Date: Mon, 28 Nov 2016 13:43:38 -0800
Subject: [PATCH] Add README notes and CHANGELOG entries

documentation for usage of the new optional calling-method logging
---
 CHANGELOG.md |  4 ++++
 README.md    | 18 +++++++++++++++++-
 2 files changed, 21 insertions(+), 1 deletion(-)

diff --git a/CHANGELOG.md b/CHANGELOG.md
index f2c2bc2..0d84a2f 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -1,3 +1,7 @@
+# 0.11.0
+
+* feature: Add optional logging of caller method
+
 # 0.10.0
 
 * feature: Add a test hook (#180)
diff --git a/README.md b/README.md
index 275c113..57f15e4 100644
--- a/README.md
+++ b/README.md
@@ -43,9 +43,9 @@ time="2015-03-26T01:27:38-04:00" level=warning msg="The group's number increased
 time="2015-03-26T01:27:38-04:00" level=debug msg="Temperature changes" temperature=-4
 time="2015-03-26T01:27:38-04:00" level=panic msg="It's over 9000!" animal=orca size=9009
 time="2015-03-26T01:27:38-04:00" level=fatal msg="The ice breaks!" err=&{0x2082280c0 map[animal:orca size:9009] 2015-03-26 01:27:38.441574009 -0400 EDT panic It's over 9000!} number=100 omg=true
-exit status 1
 ```
 To ensure this behaviour even if a TTY is attached, set your formatter as follows:
+
 ```
 	log.SetFormatter(&log.TextFormatter{
 		DisableColors: true,
@@ -53,6 +53,22 @@ To ensure this behaviour even if a TTY is attached, set your formatter as follow
 	})
 ```
 
+If you wish to add the calling method as a field, instruct the logger via:
+```
+log.SetReportMethod(true)
+```
+This adds the caller as 'method' like so:
+
+```json
+{"animal":"penguin","level":"fatal","method":"arcticcreatures.migrate","msg":"a penguin swims by",
+"time":"2014-03-10 19:57:38.562543129 -0400 EDT"}
+
+```
+
+```text
+time="2015-03-26T01:27:38-04:00" level=fatal method=arcticcreatures.migrate msg="a penguin swims by" animal=penguin
+
+```
 #### Example
 
 The simplest way to use Logrus is simply the package-level exported logger: