Instrument.Types

Documentation

createInstrumentPool :: ConnectInfo -> IO Connection

type Samplers = Map (MetricName, Dimensions) Sampler

type Counters = Map (MetricName, Dimensions) Counter

data Instrument

Constructors

I

Fields

• hostName :: HostName
• samplers :: !(IORef Samplers)
• counters :: !(IORef Counters)
• redis :: Connection

Instances

Monad m => HasInstrument (ReaderT Instrument m)

Defined in Instrument.ClientClass

Methods

getInstrument :: ReaderT Instrument m Instrument

data InstrumentConfig

Constructors

ICfg

Fields

• redisQueueBound :: Maybe Integer

Instances

Default InstrumentConfig

Defined in Instrument.Types

Methods

def :: InstrumentConfig

data SubmissionPacket

Constructors

SP

Fields

• spTimeStamp :: !Double

  Timing of this submission

• spName :: !MetricName

  Metric name

• spPayload :: !Payload

  Collected values

• spDimensions :: !Dimensions

  Defines slices that this packet belongs to. This allows drill-down on the backends. For instance, you could do "server_name" "app1" or "queue_name" "my_queue"

Instances

Generic SubmissionPacket

Defined in Instrument.Types

Associated Types

type Rep SubmissionPacket :: Type -> Type

Methods

from :: SubmissionPacket -> Rep SubmissionPacket x

to :: Rep SubmissionPacket x -> SubmissionPacket

Show SubmissionPacket

Defined in Instrument.Types

Methods

showsPrec :: Int -> SubmissionPacket -> ShowS

show :: SubmissionPacket -> String

showList :: [SubmissionPacket] -> ShowS

Serialize SubmissionPacket

Defined in Instrument.Types

Methods

put :: Putter SubmissionPacket

get :: Get SubmissionPacket

Eq SubmissionPacket

Defined in Instrument.Types

Methods

(==) :: SubmissionPacket -> SubmissionPacket -> Bool

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

Migrate SubmissionPacket

Defined in Instrument.Types

Associated Types

type MigrateFrom SubmissionPacket

Methods

migrate :: MigrateFrom SubmissionPacket -> SubmissionPacket

SafeCopy SubmissionPacket

Defined in Instrument.Types

Methods

version :: Version SubmissionPacket

kind :: Kind SubmissionPacket

getCopy :: Contained (Get SubmissionPacket)

putCopy :: SubmissionPacket -> Contained Put

internalConsistency :: Consistency SubmissionPacket

objectProfile :: Profile SubmissionPacket

errorTypeName :: Proxy SubmissionPacket -> String

type Rep SubmissionPacket

Defined in Instrument.Types

type Rep SubmissionPacket = D1 ('MetaData "SubmissionPacket" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'False) (C1 ('MetaCons "SP" 'PrefixI 'True) ((S1 ('MetaSel ('Just "spTimeStamp") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Double) :*: S1 ('MetaSel ('Just "spName") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 MetricName)) :*: (S1 ('MetaSel ('Just "spPayload") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Payload) :*: S1 ('MetaSel ('Just "spDimensions") 'NoSourceUnpackedness 'SourceStrict 'DecidedStrict) (Rec0 Dimensions))))

type MigrateFrom SubmissionPacket

Defined in Instrument.Types

type MigrateFrom SubmissionPacket

newtype MetricName

Constructors

MetricName

Fields

• metricName :: String

Instances

IsString MetricName

Defined in Instrument.Types

Methods

fromString :: String -> MetricName

Generic MetricName

Defined in Instrument.Types

Associated Types

type Rep MetricName :: Type -> Type

Methods

from :: MetricName -> Rep MetricName x

to :: Rep MetricName x -> MetricName

Show MetricName

Defined in Instrument.Types

Methods

showsPrec :: Int -> MetricName -> ShowS

show :: MetricName -> String

showList :: [MetricName] -> ShowS

Serialize MetricName

Defined in Instrument.Types

Methods

put :: Putter MetricName

get :: Get MetricName

Eq MetricName

Defined in Instrument.Types

Methods

(==) :: MetricName -> MetricName -> Bool

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

Ord MetricName

Defined in Instrument.Types

Methods

compare :: MetricName -> MetricName -> Ordering

(<) :: MetricName -> MetricName -> Bool

(<=) :: MetricName -> MetricName -> Bool

(>) :: MetricName -> MetricName -> Bool

(>=) :: MetricName -> MetricName -> Bool

max :: MetricName -> MetricName -> MetricName

min :: MetricName -> MetricName -> MetricName

SafeCopy MetricName

Defined in Instrument.Types

Methods

version :: Version MetricName

kind :: Kind MetricName

getCopy :: Contained (Get MetricName)

putCopy :: MetricName -> Contained Put

internalConsistency :: Consistency MetricName

objectProfile :: Profile MetricName

errorTypeName :: Proxy MetricName -> String

type Rep MetricName

Defined in Instrument.Types

type Rep MetricName = D1 ('MetaData "MetricName" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'True) (C1 ('MetaCons "MetricName" 'PrefixI 'True) (S1 ('MetaSel ('Just "metricName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 String)))

newtype DimensionName

Constructors

DimensionName

Fields

• dimensionName :: Text

Instances

IsString DimensionName

Defined in Instrument.Types

Methods

fromString :: String -> DimensionName

Generic DimensionName

Defined in Instrument.Types

Associated Types

type Rep DimensionName :: Type -> Type

Methods

from :: DimensionName -> Rep DimensionName x

to :: Rep DimensionName x -> DimensionName

Show DimensionName

Defined in Instrument.Types

Methods

showsPrec :: Int -> DimensionName -> ShowS

show :: DimensionName -> String

showList :: [DimensionName] -> ShowS

Serialize DimensionName

Defined in Instrument.Types

Methods

put :: Putter DimensionName

get :: Get DimensionName

Eq DimensionName

Defined in Instrument.Types

Methods

(==) :: DimensionName -> DimensionName -> Bool

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

Ord DimensionName

Defined in Instrument.Types

Methods

compare :: DimensionName -> DimensionName -> Ordering

(<) :: DimensionName -> DimensionName -> Bool

(<=) :: DimensionName -> DimensionName -> Bool

(>) :: DimensionName -> DimensionName -> Bool

(>=) :: DimensionName -> DimensionName -> Bool

max :: DimensionName -> DimensionName -> DimensionName

min :: DimensionName -> DimensionName -> DimensionName

SafeCopy DimensionName

Defined in Instrument.Types

Methods

version :: Version DimensionName

kind :: Kind DimensionName

getCopy :: Contained (Get DimensionName)

putCopy :: DimensionName -> Contained Put

internalConsistency :: Consistency DimensionName

objectProfile :: Profile DimensionName

errorTypeName :: Proxy DimensionName -> String

type Rep DimensionName

Defined in Instrument.Types

type Rep DimensionName = D1 ('MetaData "DimensionName" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'True) (C1 ('MetaCons "DimensionName" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensionName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

newtype DimensionValue

Constructors

DimensionValue

Fields

• dimensionValue :: Text

Instances

IsString DimensionValue

Defined in Instrument.Types

Methods

fromString :: String -> DimensionValue

Generic DimensionValue

Defined in Instrument.Types

Associated Types

type Rep DimensionValue :: Type -> Type

Methods

from :: DimensionValue -> Rep DimensionValue x

to :: Rep DimensionValue x -> DimensionValue

Show DimensionValue

Defined in Instrument.Types

Methods

showsPrec :: Int -> DimensionValue -> ShowS

show :: DimensionValue -> String

showList :: [DimensionValue] -> ShowS

Serialize DimensionValue

Defined in Instrument.Types

Methods

put :: Putter DimensionValue

get :: Get DimensionValue

Eq DimensionValue

Defined in Instrument.Types

Methods

(==) :: DimensionValue -> DimensionValue -> Bool

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

Ord DimensionValue

Defined in Instrument.Types

Methods

compare :: DimensionValue -> DimensionValue -> Ordering

(<) :: DimensionValue -> DimensionValue -> Bool

(<=) :: DimensionValue -> DimensionValue -> Bool

(>) :: DimensionValue -> DimensionValue -> Bool

(>=) :: DimensionValue -> DimensionValue -> Bool

max :: DimensionValue -> DimensionValue -> DimensionValue

min :: DimensionValue -> DimensionValue -> DimensionValue

SafeCopy DimensionValue

Defined in Instrument.Types

Methods

version :: Version DimensionValue

kind :: Kind DimensionValue

getCopy :: Contained (Get DimensionValue)

putCopy :: DimensionValue -> Contained Put

internalConsistency :: Consistency DimensionValue

objectProfile :: Profile DimensionValue

errorTypeName :: Proxy DimensionValue -> String

type Rep DimensionValue

Defined in Instrument.Types

type Rep DimensionValue = D1 ('MetaData "DimensionValue" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'True) (C1 ('MetaCons "DimensionValue" 'PrefixI 'True) (S1 ('MetaSel ('Just "dimensionValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

type Dimensions = Map DimensionName DimensionValue

data Payload

Constructors

Samples

Fields

• unSamples :: [Double]

Counter

Fields

• unCounter :: Integer

Instances

Generic Payload

Defined in Instrument.Types

Associated Types

type Rep Payload :: Type -> Type

Methods

from :: Payload -> Rep Payload x

to :: Rep Payload x -> Payload

Show Payload

Defined in Instrument.Types

Methods

showsPrec :: Int -> Payload -> ShowS

show :: Payload -> String

showList :: [Payload] -> ShowS

Serialize Payload

Defined in Instrument.Types

Methods

put :: Putter Payload

get :: Get Payload

Eq Payload

Defined in Instrument.Types

Methods

(==) :: Payload -> Payload -> Bool

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

Migrate Payload

Defined in Instrument.Types

Associated Types

type MigrateFrom Payload

Methods

migrate :: MigrateFrom Payload -> Payload

SafeCopy Payload

Defined in Instrument.Types

Methods

version :: Version Payload

kind :: Kind Payload

getCopy :: Contained (Get Payload)

putCopy :: Payload -> Contained Put

internalConsistency :: Consistency Payload

objectProfile :: Profile Payload

errorTypeName :: Proxy Payload -> String

type Rep Payload

Defined in Instrument.Types

type Rep Payload = D1 ('MetaData "Payload" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'False) (C1 ('MetaCons "Samples" 'PrefixI 'True) (S1 ('MetaSel ('Just "unSamples") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Double])) :+: C1 ('MetaCons "Counter" 'PrefixI 'True) (S1 ('MetaSel ('Just "unCounter") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

type MigrateFrom Payload

Defined in Instrument.Types

type MigrateFrom Payload

data Aggregated

Constructors

Aggregated

Fields

• aggTS :: Double

  Timestamp for this aggregation

• aggName :: MetricName

  Name of the metric

• aggPayload :: AggPayload

  Calculated stats for the metric

• aggDimensions :: Dimensions

Instances

Generic Aggregated

Defined in Instrument.Types

Associated Types

type Rep Aggregated :: Type -> Type

Methods

from :: Aggregated -> Rep Aggregated x

to :: Rep Aggregated x -> Aggregated

Show Aggregated

Defined in Instrument.Types

Methods

showsPrec :: Int -> Aggregated -> ShowS

show :: Aggregated -> String

showList :: [Aggregated] -> ShowS

Serialize Aggregated

Defined in Instrument.Types

Methods

put :: Putter Aggregated

get :: Get Aggregated

Default Aggregated

Defined in Instrument.Types

Methods

def :: Aggregated

Eq Aggregated

Defined in Instrument.Types

Methods

(==) :: Aggregated -> Aggregated -> Bool

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

Migrate Aggregated

Defined in Instrument.Types

Associated Types

type MigrateFrom Aggregated

Methods

migrate :: MigrateFrom Aggregated -> Aggregated

SafeCopy Aggregated

Defined in Instrument.Types

Methods

version :: Version Aggregated

kind :: Kind Aggregated

getCopy :: Contained (Get Aggregated)

putCopy :: Aggregated -> Contained Put

internalConsistency :: Consistency Aggregated

objectProfile :: Profile Aggregated

errorTypeName :: Proxy Aggregated -> String

type Rep Aggregated

Defined in Instrument.Types

type Rep Aggregated = D1 ('MetaData "Aggregated" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'False) (C1 ('MetaCons "Aggregated" 'PrefixI 'True) ((S1 ('MetaSel ('Just "aggTS") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "aggName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 MetricName)) :*: (S1 ('MetaSel ('Just "aggPayload") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 AggPayload) :*: S1 ('MetaSel ('Just "aggDimensions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Dimensions))))

type MigrateFrom Aggregated

Defined in Instrument.Types

type MigrateFrom Aggregated

data AggPayload

Constructors

AggStats Stats

AggCount Integer

Instances

Generic AggPayload

Defined in Instrument.Types

Associated Types

type Rep AggPayload :: Type -> Type

Methods

from :: AggPayload -> Rep AggPayload x

to :: Rep AggPayload x -> AggPayload

Show AggPayload

Defined in Instrument.Types

Methods

showsPrec :: Int -> AggPayload -> ShowS

show :: AggPayload -> String

showList :: [AggPayload] -> ShowS

Serialize AggPayload

Defined in Instrument.Types

Methods

put :: Putter AggPayload

get :: Get AggPayload

Default AggPayload

Defined in Instrument.Types

Methods

def :: AggPayload

Eq AggPayload

Defined in Instrument.Types

Methods

(==) :: AggPayload -> AggPayload -> Bool

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

Migrate AggPayload

Defined in Instrument.Types

Associated Types

type MigrateFrom AggPayload

Methods

migrate :: MigrateFrom AggPayload -> AggPayload

SafeCopy AggPayload

Defined in Instrument.Types

Methods

version :: Version AggPayload

kind :: Kind AggPayload

getCopy :: Contained (Get AggPayload)

putCopy :: AggPayload -> Contained Put

internalConsistency :: Consistency AggPayload

objectProfile :: Profile AggPayload

errorTypeName :: Proxy AggPayload -> String

type Rep AggPayload

Defined in Instrument.Types

type Rep AggPayload = D1 ('MetaData "AggPayload" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'False) (C1 ('MetaCons "AggStats" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Stats)) :+: C1 ('MetaCons "AggCount" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Integer)))

type MigrateFrom AggPayload

Defined in Instrument.Types

type MigrateFrom AggPayload

data Stats

Constructors

Stats

Fields

• smean :: Double
• ssum :: Double
• scount :: Int
• smax :: Double
• smin :: Double
• srange :: Double
• sstdev :: Double
• sskewness :: Double
• skurtosis :: Double
• squantiles :: Map Int Double

Instances

Generic Stats

Defined in Instrument.Types

Associated Types

type Rep Stats :: Type -> Type

Methods

from :: Stats -> Rep Stats x

to :: Rep Stats x -> Stats

Show Stats

Defined in Instrument.Types

Methods

showsPrec :: Int -> Stats -> ShowS

show :: Stats -> String

showList :: [Stats] -> ShowS

Serialize Stats

Defined in Instrument.Types

Methods

put :: Putter Stats

get :: Get Stats

Default Stats

Defined in Instrument.Types

Methods

def :: Stats

Eq Stats

Defined in Instrument.Types

Methods

(==) :: Stats -> Stats -> Bool

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

SafeCopy Stats

Defined in Instrument.Types

Methods

version :: Version Stats

kind :: Kind Stats

getCopy :: Contained (Get Stats)

putCopy :: Stats -> Contained Put

internalConsistency :: Consistency Stats

objectProfile :: Profile Stats

errorTypeName :: Proxy Stats -> String

type Rep Stats

Defined in Instrument.Types

type Rep Stats = D1 ('MetaData "Stats" "Instrument.Types" "instrument-0.6.1.0-6Lbe4kLcaNb1isRA7npnNm" 'False) (C1 ('MetaCons "Stats" 'PrefixI 'True) (((S1 ('MetaSel ('Just "smean") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "ssum") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "scount") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel ('Just "smax") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "smin") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)))) :*: ((S1 ('MetaSel ('Just "srange") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "sstdev") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double)) :*: (S1 ('MetaSel ('Just "sskewness") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: (S1 ('MetaSel ('Just "skurtosis") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Double) :*: S1 ('MetaSel ('Just "squantiles") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Map Int Double)))))))

hostDimension :: DimensionName

Convention for the dimension of the hostname. Used in the client to inject hostname into the parameters map

data HostDimensionPolicy

Should we automatically pull the host and add it as a dimension. Used at the call site of the various metrics (timeI, sampleI, etc). Hosts are basically grandfathered in as a dimension and the functionality of automatically injecting them is useful, but it is not relevant to some metrics and actually makes some metrics difficult to use depending on the backend, so we made them opt-in.

Constructors

AddHostDimension

DoNotAddHostDimension

Instances

Show HostDimensionPolicy

Defined in Instrument.Types

Methods

showsPrec :: Int -> HostDimensionPolicy -> ShowS

show :: HostDimensionPolicy -> String

showList :: [HostDimensionPolicy] -> ShowS

Eq HostDimensionPolicy

Defined in Instrument.Types

Methods

(==) :: HostDimensionPolicy -> HostDimensionPolicy -> Bool

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

newtype Quantile

Integer quantile, valid values range from 1-99, inclusive.

Constructors

Q

Fields

• quantile :: Int

Instances

Bounded Quantile

Defined in Instrument.Types

Methods

minBound :: Quantile

maxBound :: Quantile

Show Quantile

Defined in Instrument.Types

Methods

showsPrec :: Int -> Quantile -> ShowS

show :: Quantile -> String

showList :: [Quantile] -> ShowS

Eq Quantile

Defined in Instrument.Types

Methods

(==) :: Quantile -> Quantile -> Bool

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

Ord Quantile

Defined in Instrument.Types

Methods

compare :: Quantile -> Quantile -> Ordering

(<) :: Quantile -> Quantile -> Bool

(<=) :: Quantile -> Quantile -> Bool

(>) :: Quantile -> Quantile -> Bool

(>=) :: Quantile -> Quantile -> Bool

max :: Quantile -> Quantile -> Quantile

min :: Quantile -> Quantile -> Quantile