Yesod.Katip.Class

This module defines the classes associated with the site transformers KatipSite and KatipContextSite.

It also includes instances for Katip and KatipContext (the Katip classes) which let you invoke the Katip logging APIs in your handlers, provided the site itself satisfies the SiteKatip or SiteKatipContext class respectively.

By default, you won't need to use any of these APIs directly. While the classes defined here have APIs identical to their Katip counterparts, it's always better to rely on the Katip APIs.

Documentation

class SiteKatip site where

A class for sites which provide a Katip-equivalent API

Methods

getLogEnv :: MonadSite m => m site LogEnv

localLogEnv :: MonadSite m => (LogEnv -> LogEnv) -> m site a -> m site a

Instances

(SiteTrans t, SiteKatip site) => SiteKatip (t site)

Defined in Yesod.Katip.Class

Methods

getLogEnv :: MonadSite m => m (t site) LogEnv

localLogEnv :: MonadSite m => (LogEnv -> LogEnv) -> m (t site) a -> m (t site) a

SiteKatip (KatipSite site)

Defined in Yesod.Katip

Methods

getLogEnv :: MonadSite m => m (KatipSite site) LogEnv

localLogEnv :: MonadSite m => (LogEnv -> LogEnv) -> m (KatipSite site) a -> m (KatipSite site) a

SiteKatip (KatipContextSite site)

Defined in Yesod.Katip

Methods

getLogEnv :: MonadSite m => m (KatipContextSite site) LogEnv

localLogEnv :: MonadSite m => (LogEnv -> LogEnv) -> m (KatipContextSite site) a -> m (KatipContextSite site) a

class SiteKatip site => SiteKatipContext site where

A class for sites which provide a KatipContext-equivalent API

Methods

getKatipContext :: MonadSite m => m site LogContexts

localKatipContext :: MonadSite m => (LogContexts -> LogContexts) -> m site a -> m site a

getKatipNamespace :: MonadSite m => m site Namespace

localKatipNamespace :: MonadSite m => (Namespace -> Namespace) -> m site a -> m site a

Instances

(SiteTrans t, SiteKatipContext site) => SiteKatipContext (t site)

Defined in Yesod.Katip.Class

Methods

getKatipContext :: MonadSite m => m (t site) LogContexts

localKatipContext :: MonadSite m => (LogContexts -> LogContexts) -> m (t site) a -> m (t site) a

getKatipNamespace :: MonadSite m => m (t site) Namespace

localKatipNamespace :: MonadSite m => (Namespace -> Namespace) -> m (t site) a -> m (t site) a

SiteKatipContext (KatipContextSite site)

Defined in Yesod.Katip

Methods

getKatipContext :: MonadSite m => m (KatipContextSite site) LogContexts

localKatipContext :: MonadSite m => (LogContexts -> LogContexts) -> m (KatipContextSite site) a -> m (KatipContextSite site) a

getKatipNamespace :: MonadSite m => m (KatipContextSite site) Namespace

localKatipNamespace :: MonadSite m => (Namespace -> Namespace) -> m (KatipContextSite site) a -> m (KatipContextSite site) a

Orphan instances

(MonadSite m, SiteKatipContext site) => KatipContext (m site)

Methods

getKatipContext :: m site LogContexts

localKatipContext :: (LogContexts -> LogContexts) -> m site a -> m site a

getKatipNamespace :: m site Namespace

localKatipNamespace :: (Namespace -> Namespace) -> m site a -> m site a

(MonadSite m, SiteKatip site) => Katip (m site)

Methods

getLogEnv :: m site LogEnv

localLogEnv :: (LogEnv -> LogEnv) -> m site a -> m site a