From bff3a04186d1fb51325b90ec9ee1549c69121ad5 Mon Sep 17 00:00:00 2001 From: Bernerd Schaefer Date: Thu, 25 Jun 2020 13:52:09 -0700 Subject: [PATCH] Update README.md Preparing for a v0.2.0 release with new async delivery behavior. --- README.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 46bc663..3f16698 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,11 @@ Rollrus is what happens when [Logrus](https://github.com/sirupsen/logrus) meets [Rollbar](github.com/rollbar/rollbar-go). -When a .Error, .Fatal or .Panic logging function is called, report the details to Rollbar via a Logrus hook. +Install the hook into a Logrus logger to report logged messages to Rollbar. +By default, only messages with the Error, Fatal, or Panic level are reported. -Delivery is synchronous to help ensure that logs are delivered. +Panic and Fatal errors are reported synchronously to help ensure that logs are delivered before the process exits. +All other messages are delivered in the background, and may be dropped if the queue is full. If the error includes a [`StackTrace`](https://godoc.org/github.com/pkg/errors#StackTrace), that `StackTrace` is reported to rollbar.