Haxl.Core.Stats

Types and operations for statistics and profiling. Most users should import Haxl.Core instead of importing this module directly.

Data-source stats

newtype Stats

Stats that we collect along the way.

Constructors

Stats [FetchStats]

Instances

Show Stats

Defined in Haxl.Core.Stats

Methods

showsPrec :: Int -> Stats -> ShowS

show :: Stats -> String

showList :: [Stats] -> ShowS

Semigroup Stats

Defined in Haxl.Core.Stats

Methods

(<>) :: Stats -> Stats -> Stats

sconcat :: NonEmpty Stats -> Stats

stimes :: Integral b => b -> Stats -> Stats

Monoid Stats

Defined in Haxl.Core.Stats

Methods

mempty :: Stats

mappend :: Stats -> Stats -> Stats

mconcat :: [Stats] -> Stats

ToJSON Stats

Defined in Haxl.Core.Stats

Methods

toJSON :: Stats -> Value

toEncoding :: Stats -> Encoding

toJSONList :: [Stats] -> Value

toEncodingList :: [Stats] -> Encoding

type CallId = Int

data FetchStats

Maps data source name to the number of requests made in that round. The map only contains entries for sources that made requests in that round.

Constructors

FetchStats

Timing stats for a (batched) data fetch

Fields

• fetchDataSource :: Text
• fetchBatchSize :: !Int
• fetchStart :: !Timestamp
• fetchDuration :: !Microseconds
• fetchSpace :: !Int64
• fetchFailures :: !Int
• fetchIgnoredFailures :: !Int
• fetchBatchId :: !Int
• fetchIds :: [CallId]

FetchCall

The stack trace of a call to dataFetch. These are collected only when profiling and reportLevel is 5 or greater.

Fields

• fetchReq :: String
• fetchStack :: [String]
• fetchStatId :: !CallId

MemoCall

Fields

• memoStatId :: !CallId
• memoSpace :: !Int64

FetchWait

Fields

• fetchWaitReqs :: HashMap Text Int

  What DataSources had requests that were being waited for

• fetchWaitStart :: !Timestamp
• fetchWaitDuration :: !Microseconds

Instances

Eq FetchStats

Defined in Haxl.Core.Stats

Methods

(==) :: FetchStats -> FetchStats -> Bool

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

Show FetchStats

Defined in Haxl.Core.Stats

Methods

showsPrec :: Int -> FetchStats -> ShowS

show :: FetchStats -> String

showList :: [FetchStats] -> ShowS

ToJSON FetchStats

Defined in Haxl.Core.Stats

Methods

toJSON :: FetchStats -> Value

toEncoding :: FetchStats -> Encoding

toJSONList :: [FetchStats] -> Value

toEncodingList :: [FetchStats] -> Encoding

type Microseconds = Int64

type Timestamp = Microseconds

getTimestamp :: IO Timestamp

emptyStats :: Stats

numFetches :: Stats -> Int

ppStats :: Stats -> String

Pretty-print Stats.

ppFetchStats :: FetchStats -> String

Pretty-print RoundStats.

aggregateFetchBatches :: ([FetchStats] -> a) -> Stats -> [a]

Aggregate stats merging FetchStats from the same dispatched batch into one.

Profiling

data Profile

Constructors

Profile

Fields

• profile :: HashMap ProfileKey ProfileData

  Data per key (essentially per call stack)

• profileTree :: HashMap (ProfileLabel, ProfileKey) ProfileKey

  (label, parent) -> current. The exception is the root which will have (MAIN, 0) -> 0

• profileNextKey :: ProfileKey

  Provides a unique key per callstack

data ProfileMemo

Constructors

ProfileMemo

Fields

• profileMemoId :: !CallId
• profileMemoWasCached :: !Bool

Instances

Eq ProfileMemo

Defined in Haxl.Core.Stats

Methods

(==) :: ProfileMemo -> ProfileMemo -> Bool

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

Show ProfileMemo

Defined in Haxl.Core.Stats

Methods

showsPrec :: Int -> ProfileMemo -> ShowS

show :: ProfileMemo -> String

showList :: [ProfileMemo] -> ShowS

data ProfileFetch

Constructors

ProfileFetch

Fields

• profileFetchFetchId :: !CallId
• profileFetchMemoId :: !CallId
• profileFetchWasCached :: !Bool

Instances

Eq ProfileFetch

Defined in Haxl.Core.Stats

Methods

(==) :: ProfileFetch -> ProfileFetch -> Bool

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

Show ProfileFetch

Defined in Haxl.Core.Stats

Methods

showsPrec :: Int -> ProfileFetch -> ShowS

show :: ProfileFetch -> String

showList :: [ProfileFetch] -> ShowS

emptyProfile :: Profile

type ProfileKey = Int64

type ProfileLabel = Text

data ProfileData

Constructors

ProfileData

Fields

• profileAllocs :: !AllocCount

  allocations made by this label

• profileFetches :: [ProfileFetch]

  fetches made in this label

• profileLabelHits :: !LabelHitCount

  number of hits at this label

• profileMemos :: [ProfileMemo]

  memo and a boolean representing if it was cached at the time

• profileTime :: !Microseconds

  amount of time spent in computation at this label

Instances

Show ProfileData

Defined in Haxl.Core.Stats

Methods

showsPrec :: Int -> ProfileData -> ShowS

show :: ProfileData -> String

showList :: [ProfileData] -> ShowS

emptyProfileData :: ProfileData

type AllocCount = Int64

type LabelHitCount = Int64

Allocation

getAllocationCounter :: IO Int64

Return the current value of the allocation counter for the current thread.

Since: base-4.8.0.0

setAllocationCounter :: Int64 -> IO ()

Every thread has an allocation counter that tracks how much memory has been allocated by the thread. The counter is initialized to zero, and setAllocationCounter sets the current value. The allocation counter counts *down*, so in the absence of a call to setAllocationCounter its value is the negation of the number of bytes of memory allocated by the thread.

There are two things that you can do with this counter:

• Use it as a simple profiling mechanism, with getAllocationCounter.
• Use it as a resource limit. See enableAllocationLimit.

Allocation accounting is accurate only to about 4Kbytes.

Since: base-4.8.0.0