aboutsummaryrefslogtreecommitdiff
path: root/vendor/github.com/Xe/ln/README.md
diff options
context:
space:
mode:
authorChristine Dodrill <me@christine.website>2017-12-13 10:43:58 -0800
committerChristine Dodrill <me@christine.website>2017-12-13 10:43:58 -0800
commit91dd3b19f69bfbeefb22c66f75ea3321f2f97bb8 (patch)
tree39b7911168d9ffc501894b79842975735bde6c81 /vendor/github.com/Xe/ln/README.md
parent141a3320ff790cbaa52319371de530ae9fd09d89 (diff)
downloadxesite-91dd3b19f69bfbeefb22c66f75ea3321f2f97bb8.tar.xz
xesite-91dd3b19f69bfbeefb22c66f75ea3321f2f97bb8.zip
convert to go buildpack
Diffstat (limited to 'vendor/github.com/Xe/ln/README.md')
-rw-r--r--vendor/github.com/Xe/ln/README.md29
1 files changed, 29 insertions, 0 deletions
diff --git a/vendor/github.com/Xe/ln/README.md b/vendor/github.com/Xe/ln/README.md
new file mode 100644
index 0000000..61fc941
--- /dev/null
+++ b/vendor/github.com/Xe/ln/README.md
@@ -0,0 +1,29 @@
+# ln: The Natural Logger for Go
+
+`ln` provides a simple interface to logging, and metrics, and
+obviates the need to utilize purpose built metrics packages, like
+`go-metrics` for simple use cases.
+
+The design of `ln` centers around the idea of key-value pairs, which
+can be interpreted on the fly, but "Filters" to do things such as
+aggregated metrics, and report said metrics to, say Librato, or
+statsd.
+
+"Filters" are like WSGI, or Rack Middleware. They are run "top down"
+and can abort an emitted log's output at any time, or continue to let
+it through the chain. However, the interface is slightly different
+than that. Rather than encapsulating the chain with partial function
+application, we utilize a simpler method, namely, each plugin defines
+an `Apply` function, which takes as an argument the log event, and
+performs the work of the plugin, only if the Plugin "Applies" to this
+log event.
+
+If `Apply` returns `false`, the iteration through the rest of the
+filters is aborted, and the log is dropped from further processing.
+
+## Current Status: Initial Development / Concept
+
+## Copyright
+
+(c) 2015, Andrew Gwozdziewycz, BSD Licensed. See LICENSE for more
+info.