This repository has been archived by the owner on Aug 18, 2020. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 629
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[CBR-211] log rotation checks for size and age of files
Signed-off-by: Alexander Diemand <[email protected]>
- Loading branch information
Showing
7 changed files
with
299 additions
and
69 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,146 @@ | ||
| {-# LANGUAGE RecordWildCards #-} | ||
|
|
||
| -- | monitor log files for max age and max size | ||
|
|
||
| module Pos.Util.Log.Rotator | ||
| ( cleanupRotator | ||
| , evalRotator | ||
| , initializeRotator | ||
| ) where | ||
|
|
||
| import Universum | ||
|
|
||
| import Control.Exception.Safe (Exception (..), catchIO) | ||
|
|
||
| import qualified Data.List.NonEmpty as NE | ||
| import Data.Time (UTCTime, addUTCTime, diffUTCTime, getCurrentTime, | ||
| parseTimeM) | ||
| import Data.Time.Format (defaultTimeLocale, formatTime) | ||
|
|
||
| import Pos.Util.Log.Internal (FileDescription (..)) | ||
| import Pos.Util.Log.LoggerConfig | ||
|
|
||
| import System.Directory (listDirectory, removeFile) | ||
| import System.FilePath ((</>)) | ||
| import System.IO (BufferMode (LineBuffering), Handle, | ||
| IOMode (WriteMode), hFileSize, hSetBuffering, stdout) | ||
|
|
||
|
|
||
| -- | format of a timestamp | ||
| tsformat :: String | ||
| tsformat = "%Y%m%d%H%M%S" | ||
|
|
||
| -- | get file path to a log file with current time | ||
| nameLogFile :: FileDescription -> IO FilePath | ||
| nameLogFile FileDescription{..} = do | ||
| now <- getCurrentTime | ||
| let tsnow = formatTime defaultTimeLocale tsformat now | ||
| return $ prefixpath </> filename ++ "-" ++ tsnow | ||
|
|
||
| -- | open a new log file | ||
| evalRotator :: RotationParameters -> FileDescription -> IO (Handle, Integer, UTCTime) | ||
| evalRotator rotation fdesc = do | ||
| let maxAge = toInteger $ rotation ^. rpMaxAgeHours | ||
| maxSize = toInteger $ rotation ^. rpLogLimitBytes | ||
|
|
||
| -- open new log file | ||
| fpath <- nameLogFile fdesc | ||
| hdl <- catchIO (openFile fpath WriteMode) $ | ||
| \e -> do | ||
| prtoutException fpath e | ||
| return stdout -- fallback to standard output in case of exception | ||
| hSetBuffering hdl LineBuffering | ||
|
|
||
| -- compute next rotation time | ||
| now <- getCurrentTime | ||
| let rottime = addUTCTime (fromInteger $ maxAge * 3600) now | ||
|
|
||
| return (hdl, maxSize, rottime) | ||
|
|
||
| prtoutException :: Exception e => FilePath -> e -> IO () | ||
| prtoutException fp e = do | ||
| putStrLn $ "error while opening log @ " ++ fp | ||
| putStrLn $ "exception: " ++ displayException e | ||
|
|
||
| -- | list filenames in prefix dir which match 'filename' | ||
| listLogFiles :: FileDescription -> IO (Maybe (NonEmpty FilePath)) | ||
| listLogFiles FileDescription{..} = do | ||
| -- find files in bp which begin with fp | ||
| files <- listDirectory $ prefixpath | ||
| return $ nonEmpty $ sort $ filter fpredicate files | ||
| where | ||
| tslen = 14 -- length of a timestamp | ||
| fplen = length filename | ||
| fpredicate path = take fplen path == filename | ||
| && take 1 (drop fplen path) == "-" | ||
| && length (drop (fplen + 1) path) == tslen | ||
|
|
||
| -- | latest log file in prefix dir which matches 'filename' | ||
| latestLogFile :: FileDescription -> IO (Maybe FilePath) | ||
| latestLogFile fdesc = | ||
| listLogFiles fdesc >>= \fs -> return $ latestLogFile' fs | ||
| where | ||
| latestLogFile' :: Maybe (NonEmpty FilePath) -> Maybe FilePath | ||
| latestLogFile' Nothing = Nothing | ||
| latestLogFile' (Just flist) = Just $ last flist | ||
|
|
||
| -- | initialize log file at startup | ||
| -- may append to existing file | ||
| initializeRotator :: RotationParameters -> FileDescription -> IO (Handle, Integer, UTCTime) | ||
| initializeRotator rotation fdesc = do | ||
| let maxAge = toInteger $ rotation ^. rpMaxAgeHours | ||
| maxSize = toInteger $ rotation ^. rpLogLimitBytes | ||
|
|
||
| latest <- latestLogFile fdesc | ||
| case latest of | ||
| Nothing -> -- no file to append, return new | ||
| evalRotator rotation fdesc | ||
| Just fname -> do | ||
| -- check date | ||
| now <- getCurrentTime | ||
| tsfp <- parseTimeM True defaultTimeLocale tsformat $ drop (fplen + 1) fname | ||
| if (round $ diffUTCTime now tsfp) > (3600 * maxAge) | ||
| then do -- file is too old, return new | ||
| evalRotator rotation fdesc | ||
| else do | ||
| hdl <- catchIO (openFile (prefixpath fdesc </> fname) AppendMode) $ | ||
| \e -> do | ||
| prtoutException fname e | ||
| return stdout -- fallback to standard output in case of exception | ||
| hSetBuffering hdl LineBuffering | ||
| cursize <- hFileSize hdl | ||
| let rottime = addUTCTime (fromInteger $ maxAge * 3600) now | ||
| return (hdl, (maxSize - cursize), rottime) | ||
| where | ||
| fplen = length $ filename fdesc | ||
|
|
||
| -- | remove old files; count them and only keep n (from config) | ||
| cleanupRotator :: RotationParameters -> FileDescription -> IO () | ||
| cleanupRotator rotation fdesc = do | ||
| let keepN0 = fromIntegral (rotation ^. rpKeepFilesNum) :: Int | ||
| keepN = max 1 $ min keepN0 99 | ||
| listLogFiles fdesc >>= removeOldFiles keepN | ||
| where | ||
| removeOldFiles :: Int -> Maybe (NonEmpty FilePath) -> IO () | ||
| removeOldFiles _ Nothing = return () | ||
| removeOldFiles n (Just flist) = do | ||
| putStrLn $ "dropping " ++ (show n) ++ " from " ++ (show flist) | ||
| removeFiles $ reverse $ NE.drop n $ NE.reverse flist | ||
| removeFiles [] = return () | ||
| removeFiles (fp : fps) = do | ||
| let bp = prefixpath fdesc | ||
| filepath = bp </> fp | ||
| putStrLn $ "removing file " ++ filepath | ||
| removeFile filepath -- destructive | ||
| removeFiles fps | ||
|
|
||
| {- | ||
| testing: | ||
| lc0 <- parseLoggerConfig "../log-configs/testing.yaml" | ||
| lc <- setLogPrefix (Just "/tmp/testlog/") lc0 | ||
| lh <- setupLogging lc | ||
| usingLoggerName lh "testing" $ do { forM_ [1..299] (\n -> logDebug $ T.pack $ "hello world " ++ (show n)) } | ||
| -} |
Oops, something went wrong.