Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay <brendan.g.hay+amazonka@gmail.com>
Stability	provisional
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Logger

Contents

Constructing a Logger
Levels
Building Messages

Description

Types and functions for constructing loggers and emitting log messages.

Synopsis

type Logger = LogLevel -> ByteStringBuilder -> IO ()
newLogger :: MonadIO m => LogLevel -> Handle -> m Logger
data LogLevel
- = Info
- | Error
- | Debug
- | Trace
logError :: (MonadIO m, ToLog a) => Logger -> a -> m ()
logInfo :: (MonadIO m, ToLog a) => Logger -> a -> m ()
logDebug :: (MonadIO m, ToLog a) => Logger -> a -> m ()
logTrace :: (MonadIO m, ToLog a) => Logger -> a -> m ()
class ToLog a where
- build :: a -> ByteStringBuilder
buildLines :: [ByteStringBuilder] -> ByteStringBuilder

Constructing a Logger

type Logger = LogLevel -> ByteStringBuilder -> IO () Source #

A logging function called by various default hooks to log informational and debug messages.

newLogger :: MonadIO m => LogLevel -> Handle -> m Logger Source #

This is a primitive logger which can be used to log builds to a Handle.

Note: A more sophisticated logging library such as tinylog or fast-logger should be used in production code.

Levels

data LogLevel Source #

Constructors

Info	Info messages supplied by the user - this level is not emitted by the library.
Error	Error messages only.
Debug	Useful debug information + info + error levels.
Trace	Includes potentially sensitive signing metadata, and non-streaming response bodies.

Instances

Instances details

ToByteString LogLevel Source #
Instance details Defined in Amazonka.Logger Methods toBS :: LogLevel -> ByteString #
FromText LogLevel Source #
Instance details Defined in Amazonka.Logger Methods fromText :: Text -> Either String LogLevel #
ToText LogLevel Source #
Instance details Defined in Amazonka.Logger Methods toText :: LogLevel -> Text #
Enum LogLevel Source #
Instance details Defined in Amazonka.Logger Methods succ :: LogLevel -> LogLevel # pred :: LogLevel -> LogLevel # toEnum :: Int -> LogLevel # fromEnum :: LogLevel -> Int # enumFrom :: LogLevel -> [LogLevel] # enumFromThen :: LogLevel -> LogLevel -> [LogLevel] # enumFromTo :: LogLevel -> LogLevel -> [LogLevel] # enumFromThenTo :: LogLevel -> LogLevel -> LogLevel -> [LogLevel] #
Generic LogLevel Source #
Instance details Defined in Amazonka.Logger Associated Types type Rep LogLevel :: Type -> Type # Methods from :: LogLevel -> Rep LogLevel x # to :: Rep LogLevel x -> LogLevel #
Show LogLevel Source #
Instance details Defined in Amazonka.Logger Methods showsPrec :: Int -> LogLevel -> ShowS # show :: LogLevel -> String # showList :: [LogLevel] -> ShowS #
Eq LogLevel Source #
Instance details Defined in Amazonka.Logger Methods (==) :: LogLevel -> LogLevel -> Bool # (/=) :: LogLevel -> LogLevel -> Bool #
Ord LogLevel Source #
Instance details Defined in Amazonka.Logger Methods compare :: LogLevel -> LogLevel -> Ordering # (<) :: LogLevel -> LogLevel -> Bool # (<=) :: LogLevel -> LogLevel -> Bool # (>) :: LogLevel -> LogLevel -> Bool # (>=) :: LogLevel -> LogLevel -> Bool # max :: LogLevel -> LogLevel -> LogLevel # min :: LogLevel -> LogLevel -> LogLevel #
type Rep LogLevel Source #
Instance details Defined in Amazonka.Logger type Rep LogLevel = D1 ('MetaData "LogLevel" "Amazonka.Logger" "amazonka-2.0-48plDWnPMAk3PGO79vdSa0" 'False) ((C1 ('MetaCons "Info" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Error" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "Debug" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Trace" 'PrefixI 'False) (U1 :: Type -> Type)))

logError :: (MonadIO m, ToLog a) => Logger -> a -> m () Source #

logInfo :: (MonadIO m, ToLog a) => Logger -> a -> m () Source #

logDebug :: (MonadIO m, ToLog a) => Logger -> a -> m () Source #

logTrace :: (MonadIO m, ToLog a) => Logger -> a -> m () Source #

Building Messages

class ToLog a where #

Methods

build :: a -> ByteStringBuilder #

Convert a value to a loggable builder.

Instances

Instances details

ToLog AuthError Source #
Instance details Defined in Amazonka.Auth.Exception Methods build :: AuthError -> ByteStringBuilder #
ToLog ChunkSize
Instance details Defined in Amazonka.Data.Body Methods build :: ChunkSize -> ByteStringBuilder #
ToLog EscapedPath
Instance details Defined in Amazonka.Data.Log Methods build :: EscapedPath -> ByteStringBuilder #
ToLog QueryString
Instance details Defined in Amazonka.Data.Log Methods build :: QueryString -> ByteStringBuilder #
ToLog ByteStringBuilder
Instance details Defined in Amazonka.Data.Log Methods build :: ByteStringBuilder -> ByteStringBuilder #
ToLog ByteStringLazy
Instance details Defined in Amazonka.Data.Log Methods build :: ByteStringLazy -> ByteStringBuilder #
ToLog TextLazy
Instance details Defined in Amazonka.Data.Log Methods build :: TextLazy -> ByteStringBuilder #
ToLog Abbrev
Instance details Defined in Amazonka.Types Methods build :: Abbrev -> ByteStringBuilder #
ToLog AccessKey
Instance details Defined in Amazonka.Types Methods build :: AccessKey -> ByteStringBuilder #
ToLog Auth
Instance details Defined in Amazonka.Types Methods build :: Auth -> ByteStringBuilder #
ToLog AuthEnv
Instance details Defined in Amazonka.Types Methods build :: AuthEnv -> ByteStringBuilder #
ToLog Error
Instance details Defined in Amazonka.Types Methods build :: Error -> ByteStringBuilder #
ToLog ErrorCode
Instance details Defined in Amazonka.Types Methods build :: ErrorCode -> ByteStringBuilder #
ToLog ErrorMessage
Instance details Defined in Amazonka.Types Methods build :: ErrorMessage -> ByteStringBuilder #
ToLog Meta
Instance details Defined in Amazonka.Types Methods build :: Meta -> ByteStringBuilder #
ToLog Region
Instance details Defined in Amazonka.Types Methods build :: Region -> ByteStringBuilder #
ToLog RequestId
Instance details Defined in Amazonka.Types Methods build :: RequestId -> ByteStringBuilder #
ToLog Seconds
Instance details Defined in Amazonka.Types Methods build :: Seconds -> ByteStringBuilder #
ToLog SerializeError
Instance details Defined in Amazonka.Types Methods build :: SerializeError -> ByteStringBuilder #
ToLog ServiceError
Instance details Defined in Amazonka.Types Methods build :: ServiceError -> ByteStringBuilder #
ToLog Accept
Instance details Defined in Amazonka.Waiter Methods build :: Accept -> ByteStringBuilder #
ToLog Int16
Instance details Defined in Amazonka.Data.Log Methods build :: Int16 -> ByteStringBuilder #
ToLog Int32
Instance details Defined in Amazonka.Data.Log Methods build :: Int32 -> ByteStringBuilder #
ToLog Int64
Instance details Defined in Amazonka.Data.Log Methods build :: Int64 -> ByteStringBuilder #
ToLog Int8
Instance details Defined in Amazonka.Data.Log Methods build :: Int8 -> ByteStringBuilder #
ToLog Word16
Instance details Defined in Amazonka.Data.Log Methods build :: Word16 -> ByteStringBuilder #
ToLog Word32
Instance details Defined in Amazonka.Data.Log Methods build :: Word32 -> ByteStringBuilder #
ToLog Word64
Instance details Defined in Amazonka.Data.Log Methods build :: Word64 -> ByteStringBuilder #
ToLog Word8
Instance details Defined in Amazonka.Data.Log Methods build :: Word8 -> ByteStringBuilder #
ToLog ByteString
Instance details Defined in Amazonka.Data.Log Methods build :: ByteString -> ByteStringBuilder #
ToLog HttpException
Instance details Defined in Amazonka.Data.Log Methods build :: HttpException -> ByteStringBuilder #
ToLog HttpExceptionContent
Instance details Defined in Amazonka.Data.Log Methods build :: HttpExceptionContent -> ByteStringBuilder #
ToLog Request
Instance details Defined in Amazonka.Data.Log Methods build :: Request -> ByteStringBuilder #
ToLog RequestBody
Instance details Defined in Amazonka.Data.Log Methods build :: RequestBody -> ByteStringBuilder #
ToLog StdMethod
Instance details Defined in Amazonka.Data.Log Methods build :: StdMethod -> ByteStringBuilder #
ToLog Status
Instance details Defined in Amazonka.Data.Log Methods build :: Status -> ByteStringBuilder #
ToLog HttpVersion
Instance details Defined in Amazonka.Data.Log Methods build :: HttpVersion -> ByteStringBuilder #
ToLog Text
Instance details Defined in Amazonka.Data.Log Methods build :: Text -> ByteStringBuilder #
ToLog UTCTime
Instance details Defined in Amazonka.Data.Log Methods build :: UTCTime -> ByteStringBuilder #
ToLog Integer
Instance details Defined in Amazonka.Data.Log Methods build :: Integer -> ByteStringBuilder #
ToLog Bool
Instance details Defined in Amazonka.Data.Log Methods build :: Bool -> ByteStringBuilder #
ToLog Char
Instance details Defined in Amazonka.Data.Log Methods build :: Char -> ByteStringBuilder #
ToLog Double
Instance details Defined in Amazonka.Data.Log Methods build :: Double -> ByteStringBuilder #
ToLog Float
Instance details Defined in Amazonka.Data.Log Methods build :: Float -> ByteStringBuilder #
ToLog Int
Instance details Defined in Amazonka.Data.Log Methods build :: Int -> ByteStringBuilder #
ToLog Word
Instance details Defined in Amazonka.Data.Log Methods build :: Word -> ByteStringBuilder #
ToLog (Sensitive a)
Instance details Defined in Amazonka.Data.Sensitive Methods build :: Sensitive a -> ByteStringBuilder #
ToLog a => ToLog (CI a)
Instance details Defined in Amazonka.Data.Log Methods build :: CI a -> ByteStringBuilder #
ToLog (Response a)
Instance details Defined in Amazonka.Data.Log Methods build :: Response a -> ByteStringBuilder #
ToLog a => ToLog (Maybe a)
Instance details Defined in Amazonka.Data.Log Methods build :: Maybe a -> ByteStringBuilder #
ToLog [Header]
Instance details Defined in Amazonka.Data.Log Methods build :: [Header] -> ByteStringBuilder #
ToLog [Char]
Instance details Defined in Amazonka.Data.Log Methods build :: [Char] -> ByteStringBuilder #

buildLines :: [ByteStringBuilder] -> ByteStringBuilder #

Intercalate a list of ByteStringBuilders with newlines.