effects-logger
Safe HaskellNone
LanguageGHC2021

Effects.Logger.Namespace

Description

Provides namespaced logging functionality on top of MonadLogger.

Since: 0.1

Synopsis

Effect

newtype Namespace Source #

Logging namespace.

Since: 0.1

Constructors

MkNamespace 

Fields

Instances

Instances details
NFData Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

rnf :: Namespace -> () #

Monoid Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

mempty :: Namespace #

mappend :: Namespace -> Namespace -> Namespace #

mconcat :: [Namespace] -> Namespace #

Semigroup Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

(<>) :: Namespace -> Namespace -> Namespace #

sconcat :: NonEmpty Namespace -> Namespace #

stimes :: Integral b => b -> Namespace -> Namespace #

IsString Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

fromString :: String -> Namespace #

Generic Namespace Source # 
Instance details

Defined in Effects.Logger.Utils

Associated Types

type Rep Namespace

Since: effects-logger-0.1

Instance details

Defined in Effects.Logger.Utils

type Rep Namespace = D1 ('MetaData "Namespace" "Effects.Logger.Utils" "effects-logger-0.1-inplace" 'True) (C1 ('MetaCons "MkNamespace" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq Text))))

Methods

from :: Namespace -> Rep Namespace x #

to :: Rep Namespace x -> Namespace #

IsList Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Associated Types

type Item Namespace 
Instance details

Defined in Effects.Logger.Utils

type Item Namespace = Text

Methods

fromList :: [Item Namespace] -> Namespace #

fromListN :: Int -> [Item Namespace] -> Namespace #

toList :: Namespace -> [Item Namespace] #

Show Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

showsPrec :: Int -> Namespace -> ShowS #

show :: Namespace -> String #

showList :: [Namespace] -> ShowS #

Eq Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

(==) :: Namespace -> Namespace -> Bool #

(/=) :: Namespace -> Namespace -> Bool #

(k ~ An_Iso, a ~ Seq Text, b ~ Seq Text) => LabelOptic "unNamespace" k Namespace Namespace a b Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

labelOptic :: Optic k NoIx Namespace Namespace a b Source #

type Rep Namespace Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

type Rep Namespace = D1 ('MetaData "Namespace" "Effects.Logger.Utils" "effects-logger-0.1-inplace" 'True) (C1 ('MetaCons "MkNamespace" 'PrefixI 'True) (S1 ('MetaSel ('Just "unNamespace") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Seq Text))))
type Item Namespace Source # 
Instance details

Defined in Effects.Logger.Utils

type Item Namespace = Text

addNamespace :: forall m env a k. (Is k A_Setter, LabelOptic' "namespace" k env Namespace, MonadReader env m) => Text -> m a -> m a Source #

Adds to the namespace.

Since: 0.1

Constraint aliases

type HasNamespace (m :: Type -> Type) env k = (Is k A_Getter, Is k A_Setter, LabelOptic' "namespace" k env Namespace, MonadReader env m) Source #

Alias for constraints required to use namespaces.

type MonadLoggerNS (m :: Type -> Type) env k = (HasNamespace m env k, MonadLogger m) Source #

Alias for HasNamespace and MonadLogger constraint.

Logging functions

Formatting

data LogFormatter Source #

Formatter for logs.

Since: 0.1

Constructors

MkLogFormatter 

Fields

Instances

Instances details
Generic LogFormatter Source # 
Instance details

Defined in Effects.Logger.Utils

Associated Types

type Rep LogFormatter

Since: effects-logger-0.1

Instance details

Defined in Effects.Logger.Utils

type Rep LogFormatter = D1 ('MetaData "LogFormatter" "Effects.Logger.Utils" "effects-logger-0.1-inplace" 'False) (C1 ('MetaCons "MkLogFormatter" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locStrategy") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LocStrategy) :*: S1 ('MetaSel ('Just "newline") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "threadLabel") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))

Methods

from :: LogFormatter -> Rep LogFormatter x #

to :: Rep LogFormatter x -> LogFormatter #

Show LogFormatter Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

showsPrec :: Int -> LogFormatter -> ShowS #

show :: LogFormatter -> String #

showList :: [LogFormatter] -> ShowS #

Eq LogFormatter Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

(==) :: LogFormatter -> LogFormatter -> Bool #

(/=) :: LogFormatter -> LogFormatter -> Bool #

(k ~ A_Lens, a ~ LocStrategy, b ~ LocStrategy) => LabelOptic "locStrategy" k LogFormatter LogFormatter a b Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

labelOptic :: Optic k NoIx LogFormatter LogFormatter a b Source #

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "newline" k LogFormatter LogFormatter a b Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

labelOptic :: Optic k NoIx LogFormatter LogFormatter a b Source #

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "threadLabel" k LogFormatter LogFormatter a b Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

labelOptic :: Optic k NoIx LogFormatter LogFormatter a b Source #

(k ~ A_Lens, a ~ Bool, b ~ Bool) => LabelOptic "timezone" k LogFormatter LogFormatter a b Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

labelOptic :: Optic k NoIx LogFormatter LogFormatter a b Source #

type Rep LogFormatter Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

type Rep LogFormatter = D1 ('MetaData "LogFormatter" "Effects.Logger.Utils" "effects-logger-0.1-inplace" 'False) (C1 ('MetaCons "MkLogFormatter" 'PrefixI 'True) ((S1 ('MetaSel ('Just "locStrategy") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 LocStrategy) :*: S1 ('MetaSel ('Just "newline") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool)) :*: (S1 ('MetaSel ('Just "threadLabel") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool) :*: S1 ('MetaSel ('Just "timezone") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Bool))))

defaultLogFormatter :: Loc -> LogFormatter Source #

LogFormatter with:

locStrategy = LocPartial loc
newline = True
threadLabel = False
timezone = False

Since: 0.1

data LocStrategy Source #

Determines how we log location data.

Since: 0.1

Constructors

LocPartial !Loc

Logs the location with filename, line, col.

Since: 0.1

LocStable !Loc

Logs the location with filename.

Since: 0.1

LocNone

No location logging.

Since: 0.1

Instances

Instances details
Generic LocStrategy Source # 
Instance details

Defined in Effects.Logger.Utils

Associated Types

type Rep LocStrategy

Since: effects-logger-0.1

Instance details

Defined in Effects.Logger.Utils

type Rep LocStrategy = D1 ('MetaData "LocStrategy" "Effects.Logger.Utils" "effects-logger-0.1-inplace" 'False) (C1 ('MetaCons "LocPartial" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Loc)) :+: (C1 ('MetaCons "LocStable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Loc)) :+: C1 ('MetaCons "LocNone" 'PrefixI 'False) (U1 :: Type -> Type)))

Methods

from :: LocStrategy -> Rep LocStrategy x #

to :: Rep LocStrategy x -> LocStrategy #

Show LocStrategy Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

showsPrec :: Int -> LocStrategy -> ShowS #

show :: LocStrategy -> String #

showList :: [LocStrategy] -> ShowS #

Eq LocStrategy Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

Methods

(==) :: LocStrategy -> LocStrategy -> Bool #

(/=) :: LocStrategy -> LocStrategy -> Bool #

type Rep LocStrategy Source #

Since: 0.1

Instance details

Defined in Effects.Logger.Utils

type Rep LocStrategy = D1 ('MetaData "LocStrategy" "Effects.Logger.Utils" "effects-logger-0.1-inplace" 'False) (C1 ('MetaCons "LocPartial" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Loc)) :+: (C1 ('MetaCons "LocStable" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Loc)) :+: C1 ('MetaCons "LocNone" 'PrefixI 'False) (U1 :: Type -> Type)))

formatLog Source #

Arguments

:: forall m env msg k. (HasCallStack, Is k A_Getter, LabelOptic' "namespace" k env Namespace, MonadReader env m, MonadThread m, MonadTime m, ToLogStr msg) 
=> LogFormatter

Formatter to use.

-> LogLevel

The level in which to log.

-> msg

Message.

-> m LogStr

Formatted LogStr.

Produces a formatted LogStr.

Example

-- [timestamp][thread_label][namespace][code_loc][level] msg
[2022-02-08 10:20:05][thread-label][one.two][filename:1:2][Warn] msg

Since: 0.1

LogStr

logStrToBs :: LogStr -> ByteString Source #

Since: 0.1

logStrToText :: LogStr -> Text Source #

Since: 0.1

Optics

LocStrategy

_LocPartial :: Prism' LocStrategy Loc Source #

Since: 0.1

_LocStable :: Prism' LocStrategy Loc Source #

Since: 0.1

_LocNone :: Prism' LocStrategy () Source #

Since: 0.1