logrus/hooks.go

35 lines
1.1 KiB
Go
Raw Permalink Normal View History

2014-03-10 23:22:08 +00:00
package logrus
2014-03-12 14:34:29 +00:00
// A hook to be fired when logging on the logging levels returned from
// `Levels()` on your implementation of the interface. Note that this is not
// fired in a goroutine or a channel with workers, you should handle such
// functionality yourself if your call is non-blocking and you don't wish for
// the logging calls for levels returned from `Levels()` to block.
2014-03-10 23:22:08 +00:00
type Hook interface {
2014-03-10 23:52:39 +00:00
Levels() []Level
2014-03-10 23:22:08 +00:00
Fire(*Entry) error
}
2014-03-12 14:34:29 +00:00
// Internal type for storing the hooks on a logger instance.
2015-06-26 15:42:49 +00:00
type LevelHooks map[Level][]Hook
2014-03-10 23:22:08 +00:00
2014-03-12 14:34:29 +00:00
// Add a hook to an instance of logger. This is called with
// `log.Hooks.Add(new(MyHook))` where `MyHook` implements the `Hook` interface.
2015-06-26 15:42:49 +00:00
func (hooks LevelHooks) Add(hook Hook) {
2014-03-10 23:22:08 +00:00
for _, level := range hook.Levels() {
hooks[level] = append(hooks[level], hook)
}
}
2014-03-12 14:34:29 +00:00
// Fire all the hooks for the passed level. Used by `entry.log` to fire
// appropriate hooks for a log entry.
2015-06-26 15:42:49 +00:00
func (hooks LevelHooks) Fire(level Level, entry *Entry) error {
2014-03-10 23:22:08 +00:00
for _, hook := range hooks[level] {
if err := hook.Fire(entry); err != nil {
return err
}
}
return nil
}