Safe Haskell	None
Language	Haskell2010

Logging.Config.Type

Synopsis

type Handler = HandlerH Identity
type Sink = SinkH Identity
type Config = ConfigH Identity
newtype ConfigException = ConfigException {
- message :: String
}
data HandlerH f
- = StreamHandler {
  - level :: HKD Level f
  - filterer :: HKD Filterer f
  - formatter :: HKD String f
  - stream :: HKD String f
  }
- | FileHandler {
  - level :: HKD Level f
  - filterer :: HKD Filterer f
  - formatter :: HKD String f
  - file :: FilePath
  - encoding :: HKD String f
  }
- | RotatingFileHandler {
  - level :: HKD Level f
  - filterer :: HKD Filterer f
  - formatter :: HKD String f
  - file :: FilePath
  - encoding :: HKD String f
  - maxBytes :: HKD Int f
  - backupCount :: HKD Int f
  }
- | TimeRotatingFileHandler {
  - level :: HKD Level f
  - filterer :: HKD Filterer f
  - formatter :: HKD String f
  - file :: FilePath
  - encoding :: HKD String f
  - timezone :: Maybe String
  - rotateTime :: HKD RotateTime f
  - backupCount :: HKD Int f
  }
data SinkH f = Sink {
- level :: HKD Level f
- filterer :: HKD Filterer f
- handlers :: HKD [String] f
- propagate :: HKD Bool f
- disabled :: HKD Bool f
}
data ConfigH f = Config {
- sinks :: HKD (MapH String SinkH f) f
- handlers :: HKD (MapH String HandlerH f) f
- formatters :: HKD (Map String String) f
- timezone :: Maybe String
- disabled :: HKD Bool f
}
createManager :: Config -> IO Manager

Documentation

type Handler = HandlerH Identity Source #

type Sink = SinkH Identity Source #

type Config = ConfigH Identity Source #

newtype ConfigException Source #

Constructors

ConfigException
Fields message :: String

Instances

Show ConfigException Source #
Instance details Defined in Logging.Config.Type Methods showsPrec :: Int -> ConfigException -> ShowS # show :: ConfigException -> String # showList :: [ConfigException] -> ShowS #
Exception ConfigException Source #
Instance details Defined in Logging.Config.Type Methods toException :: ConfigException -> SomeException # fromException :: SomeException -> Maybe ConfigException # displayException :: ConfigException -> String #

data HandlerH f Source #

A datatype used to decode json or yaml into Handler datatypes.

All HKD wrapped and Maybe fields are optional fields, they can be omitted.

There are tow config file templates in Logging.Config.Json and Logging.Config.Yaml.

Note: When decoding from json or yaml, use 'type' field to specify handler type.

Constructors

StreamHandler
Fields level :: HKD Level f Default is `NOTSET`. filterer :: HKD Filterer f Default is []. formatter :: HKD String f It represents key of `ConfigH'`s formatters. stream :: HKD String f Only support `stderr` and `stdout`, default is `stderr`.
FileHandler
Fields level :: HKD Level f Default is `NOTSET`. filterer :: HKD Filterer f Default is []. formatter :: HKD String f It represents key of `ConfigH'`s formatters. file :: FilePath encoding :: HKD String f See `mkTextEncoding`, default is utf8.
RotatingFileHandler
Fields level :: HKD Level f Default is `NOTSET`. filterer :: HKD Filterer f Default is []. formatter :: HKD String f It represents key of `ConfigH'`s formatters. file :: FilePath encoding :: HKD String f See `mkTextEncoding`, default is utf8. maxBytes :: HKD Int f Default is 100 MB. backupCount :: HKD Int f Default is 10.
TimeRotatingFileHandler	Since: 0.7.0
Fields level :: HKD Level f Default is `NOTSET`. filterer :: HKD Filterer f Default is []. formatter :: HKD String f It represents key of `ConfigH'`s formatters. file :: FilePath encoding :: HKD String f See `mkTextEncoding`, default is utf8. timezone :: Maybe String If not set, same as `Manager'`s timezone. rotateTime :: HKD RotateTime f Indicates when to rotate file, e.g. `D3` means every 3 days, `W4` means at 0 clock of `Thursday`, try reading and showing `RotateTime`. backupCount :: HKD Int f Default is 10.

Instances

Default HandlerH Source #
Instance details Defined in Logging.Config.Type Methods constrDef :: String -> HandlerH Identity # applyDef :: HandlerH Identity -> HandlerH Maybe -> HandlerH Identity # applyDefs :: HandlerH Maybe -> HandlerH Identity #
Generic (HandlerH f) Source #
Instance details Defined in Logging.Config.Type Associated Types type Rep (HandlerH f) :: Type -> Type # Methods from :: HandlerH f -> Rep (HandlerH f) x # to :: Rep (HandlerH f) x -> HandlerH f #
FromJSON (HandlerH Maybe) Source #
Instance details Defined in Logging.Config.Type Methods parseJSON :: Value -> Parser (HandlerH Maybe) # parseJSONList :: Value -> Parser [HandlerH Maybe] #
type Rep (HandlerH f) Source #
Instance details Defined in Logging.Config.Type type Rep (HandlerH f) = D1 (MetaData "HandlerH" "Logging.Config.Type" "log4hs-0.9.0.0-4PM0R38s3Ze40Yc5B0pDHZ" False) ((C1 (MetaCons "StreamHandler" PrefixI True) ((S1 (MetaSel (Just "level") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Level f)) :: S1 (MetaSel (Just "filterer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Filterer f))) :: (S1 (MetaSel (Just "formatter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f)) :: S1 (MetaSel (Just "stream") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f)))) :+: C1 (MetaCons "FileHandler" PrefixI True) ((S1 (MetaSel (Just "level") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Level f)) :: S1 (MetaSel (Just "filterer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Filterer f))) :: (S1 (MetaSel (Just "formatter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f)) :: (S1 (MetaSel (Just "file") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Just "encoding") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f)))))) :+: (C1 (MetaCons "RotatingFileHandler" PrefixI True) ((S1 (MetaSel (Just "level") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Level f)) :: (S1 (MetaSel (Just "filterer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Filterer f)) :: S1 (MetaSel (Just "formatter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f)))) :: ((S1 (MetaSel (Just "file") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :: S1 (MetaSel (Just "encoding") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f))) :: (S1 (MetaSel (Just "maxBytes") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Int f)) :: S1 (MetaSel (Just "backupCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Int f))))) :+: C1 (MetaCons "TimeRotatingFileHandler" PrefixI True) (((S1 (MetaSel (Just "level") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Level f)) :: S1 (MetaSel (Just "filterer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Filterer f))) :: (S1 (MetaSel (Just "formatter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f)) :: S1 (MetaSel (Just "file") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))) :: ((S1 (MetaSel (Just "encoding") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD String f)) :: S1 (MetaSel (Just "timezone") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String))) :: (S1 (MetaSel (Just "rotateTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD RotateTime f)) :: S1 (MetaSel (Just "backupCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Int f)))))))

data SinkH f Source #

Constructors

Sink
Fields level :: HKD Level f filterer :: HKD Filterer f handlers :: HKD [String] f A list of key of `ConfigH'`s handlers propagate :: HKD Bool f disabled :: HKD Bool f

Instances

Default SinkH Source #
Instance details Defined in Logging.Config.Type Methods constrDef :: String -> SinkH Identity # applyDef :: SinkH Identity -> SinkH Maybe -> SinkH Identity # applyDefs :: SinkH Maybe -> SinkH Identity #
Generic (SinkH f) Source #
Instance details Defined in Logging.Config.Type Associated Types type Rep (SinkH f) :: Type -> Type # Methods from :: SinkH f -> Rep (SinkH f) x # to :: Rep (SinkH f) x -> SinkH f #
FromJSON (SinkH Maybe) Source #
Instance details Defined in Logging.Config.Type Methods parseJSON :: Value -> Parser (SinkH Maybe) # parseJSONList :: Value -> Parser [SinkH Maybe] #
type Rep (SinkH f) Source #
Instance details Defined in Logging.Config.Type type Rep (SinkH f) = D1 (MetaData "SinkH" "Logging.Config.Type" "log4hs-0.9.0.0-4PM0R38s3Ze40Yc5B0pDHZ" False) (C1 (MetaCons "Sink" PrefixI True) ((S1 (MetaSel (Just "level") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Level f)) :: S1 (MetaSel (Just "filterer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Filterer f))) :: (S1 (MetaSel (Just "handlers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD [String] f)) :: (S1 (MetaSel (Just "propagate") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Bool f)) :: S1 (MetaSel (Just "disabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Bool f))))))

data ConfigH f Source #

Constructors

Config
Fields sinks :: HKD (MapH String SinkH f) f handlers :: HKD (MapH String HandlerH f) f formatters :: HKD (Map String String) f timezone :: Maybe String Default is the result of `getCurrentTimeZone`. Since: 0.7.0 disabled :: HKD Bool f

Instances

Default ConfigH Source #
Instance details Defined in Logging.Config.Type Methods constrDef :: String -> ConfigH Identity # applyDef :: ConfigH Identity -> ConfigH Maybe -> ConfigH Identity # applyDefs :: ConfigH Maybe -> ConfigH Identity #
Generic (ConfigH f) Source #
Instance details Defined in Logging.Config.Type Associated Types type Rep (ConfigH f) :: Type -> Type # Methods from :: ConfigH f -> Rep (ConfigH f) x # to :: Rep (ConfigH f) x -> ConfigH f #
FromJSON (ConfigH Maybe) Source #
Instance details Defined in Logging.Config.Type Methods parseJSON :: Value -> Parser (ConfigH Maybe) # parseJSONList :: Value -> Parser [ConfigH Maybe] #
type Rep (ConfigH f) Source #
Instance details Defined in Logging.Config.Type type Rep (ConfigH f) = D1 (MetaData "ConfigH" "Logging.Config.Type" "log4hs-0.9.0.0-4PM0R38s3Ze40Yc5B0pDHZ" False) (C1 (MetaCons "Config" PrefixI True) ((S1 (MetaSel (Just "sinks") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD (MapH String SinkH f) f)) :: S1 (MetaSel (Just "handlers") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD (MapH String HandlerH f) f))) :: (S1 (MetaSel (Just "formatters") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD (Map String String) f)) :: (S1 (MetaSel (Just "timezone") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Maybe String)) :: S1 (MetaSel (Just "disabled") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (HKD Bool f))))))

createManager :: Config -> IO Manager Source #

Create Logging.Manager.Manager from ConfigH.

This function is only used by Logging.Config.Json and Logging.Config.Yaml, use functions provided in these two modules directly.