Logging.Handler.TimeRotatingFileHandler

Documentation

data TimeRotatingFileHandler

A handler type which logs to a file and rotates the log at cerntain timed intervals.

Since: 0.7.0

Constructors

TimeRotatingFileHandler

Fields

• level :: Level
• filterer :: Filterer
• formatter :: Format1
• file :: FilePath
• encoding :: TextEncoding
• timezone :: TimeZone

  In most cases, it is the same value as Manager's timezone, but it won't cause problems if you set a different value.

• rotateTime :: RotateTime
• backupCount :: Int
• rotateAt :: IORef UTCTime
• stream :: MVar Handle

Instances

Eq TimeRotatingFileHandler

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

(==) :: TimeRotatingFileHandler -> TimeRotatingFileHandler -> Bool

(/=) :: TimeRotatingFileHandler -> TimeRotatingFileHandler -> Bool

Generic TimeRotatingFileHandler

Defined in Logging.Handler.TimeRotatingFileHandler

Associated Types

type Rep TimeRotatingFileHandler :: Type -> Type

Methods

from :: TimeRotatingFileHandler -> Rep TimeRotatingFileHandler x

to :: Rep TimeRotatingFileHandler x -> TimeRotatingFileHandler

Handler TimeRotatingFileHandler

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

open :: TimeRotatingFileHandler -> IO ()

emit :: TimeRotatingFileHandler -> LogRecord -> IO ()

close :: TimeRotatingFileHandler -> IO ()

handle :: TimeRotatingFileHandler -> LogRecord -> IO Bool

fromHandler :: SomeHandler -> Maybe TimeRotatingFileHandler

toHandler :: TimeRotatingFileHandler -> SomeHandler

type Rep TimeRotatingFileHandler

Defined in Logging.Handler.TimeRotatingFileHandler

type Rep TimeRotatingFileHandler = D1 (MetaData "TimeRotatingFileHandler" "Logging.Handler.TimeRotatingFileHandler" "log4hs-0.9.0.0-4PM0R38s3Ze40Yc5B0pDHZ" False) (C1 (MetaCons "TimeRotatingFileHandler" PrefixI True) (((S1 (MetaSel (Just "level") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Level) :*: S1 (MetaSel (Just "filterer") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Filterer)) :*: (S1 (MetaSel (Just "formatter") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Format1) :*: (S1 (MetaSel (Just "file") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "encoding") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TextEncoding)))) :*: ((S1 (MetaSel (Just "timezone") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 TimeZone) :*: S1 (MetaSel (Just "rotateTime") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 RotateTime)) :*: (S1 (MetaSel (Just "backupCount") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: (S1 (MetaSel (Just "rotateAt") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (IORef UTCTime)) :*: S1 (MetaSel (Just "stream") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (MVar Handle)))))))

data DayOfWeek

A datatype indicates a day of Monday-starting week.

Constructors

Monday

Tuesday

Wednesday

Thursday

Friday

Saturday

Sunday

Instances

Enum DayOfWeek

Monday-starting week means Monday is 1 and Sunday is 7

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

succ :: DayOfWeek -> DayOfWeek

pred :: DayOfWeek -> DayOfWeek

toEnum :: Int -> DayOfWeek

fromEnum :: DayOfWeek -> Int

enumFrom :: DayOfWeek -> [DayOfWeek]

enumFromThen :: DayOfWeek -> DayOfWeek -> [DayOfWeek]

enumFromTo :: DayOfWeek -> DayOfWeek -> [DayOfWeek]

enumFromThenTo :: DayOfWeek -> DayOfWeek -> DayOfWeek -> [DayOfWeek]

Eq DayOfWeek

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

(==) :: DayOfWeek -> DayOfWeek -> Bool

(/=) :: DayOfWeek -> DayOfWeek -> Bool

data RotateTime

A datatype indicates when to rotate file.

Note: This handler use 1970-01-01 00:00:00 of the given timezone as the zero time, all caculations of RotateTime are based on this zero time. Let's consider Hour 5 for example, if now is 2020-01-01 03:10:00, since there are 87658 5 hours between now and zero time, the next rotating time will be 2020-01-01 07:00:00.

Constructors

Minute Int

Every n minute(s)

Hour Int

Every n hour(s)

WeekDay DayOfWeek

At zero clock of a weekday

Day Int

Every n day(s)

Instances

Eq RotateTime

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

(==) :: RotateTime -> RotateTime -> Bool

(/=) :: RotateTime -> RotateTime -> Bool

Read RotateTime

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

readsPrec :: Int -> ReadS RotateTime

readList :: ReadS [RotateTime]

readPrec :: ReadPrec RotateTime

readListPrec :: ReadPrec [RotateTime]

Show RotateTime

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

showsPrec :: Int -> RotateTime -> ShowS

show :: RotateTime -> String

showList :: [RotateTime] -> ShowS

FromJSON RotateTime

Defined in Logging.Handler.TimeRotatingFileHandler

Methods

parseJSON :: Value -> Parser RotateTime

parseJSONList :: Value -> Parser [RotateTime]