Network.AWS.XRayClient.WAI

Module for using a WAI Middleware as an X-Ray client

Documentation

data XRayClientConfig

Configuration type for the XRay client middleware.

Constructors

XRayClientConfig

Fields

• xrayClientConfigDaemonHost :: !Text

  The host that the daemon is listening on.

• xrayClientConfigDaemonPort :: !Int

  The port that the daemon is listening on.

• xrayClientConfigApplicationName :: !Text

  The value of the "name" field that will be sent to X-Ray.

• xrayClientConfigSampler :: !(Maybe (Request -> Response -> POSIXTime -> POSIXTime -> IO Bool))

  A sampling function to filter traces.

xrayClientConfig :: Text -> XRayClientConfig

Constructor for XRayClientConfig with required arguments.

xrayTraceMiddleware :: XRayClientConfig -> Middleware

Traces the execution time of a request and sends the the local X-Ray daemon.

newtype NoAddressInfoException

Constructors

NoAddressInfoException String

Instances

Show NoAddressInfoException

Defined in Network.AWS.XRayClient.SendSegments

Methods

showsPrec :: Int -> NoAddressInfoException -> ShowS

show :: NoAddressInfoException -> String

showList :: [NoAddressInfoException] -> ShowS

Exception NoAddressInfoException

Defined in Network.AWS.XRayClient.SendSegments

Methods

toException :: NoAddressInfoException -> SomeException

fromException :: SomeException -> Maybe NoAddressInfoException

displayException :: NoAddressInfoException -> String

xrayWaiVaultKey :: Key XRayVaultData

This is a Key for the vault inside each WAI Request. It is used to get to the XRayVaultData for the current request.

vaultDataFromRequest :: Request -> Maybe XRayVaultData

Try to get XRayVaultData from the WAI Request vault.

data XRayVaultData

We use the WAI Vault to store data needed during traces.

Constructors

XRayVaultData

Fields

• xrayVaultDataTraceIdHeaderData :: !XRayTraceIdHeaderData

  Data about the current trace.

• xrayVaultDataClientConfig :: !XRayClientConfig

  Client configuration passed into the middleware.

• xrayVaultDataRootSegmentId :: !XRaySegmentId

  Segment ID of the root segment for this request.

• xrayVaultDataStdGen :: !(IORef StdGen)

  StdGen for generating segment IDs and trace IDs.

• xrayVaultDataSubsegments :: !(IORef (Seq XRaySegment))

  Current list of subsegments.

traceXRaySubsegment :: MonadUnliftIO m => Request -> Text -> (XRaySegment -> XRaySegment) -> m a -> m a

Time a MonadIO action and add it to the list of subsegments.

traceXRaySubsegment' :: MonadUnliftIO m => XRayVaultData -> Text -> (XRaySegment -> XRaySegment) -> m a -> m a

atomicallyAddVaultDataSubsegment :: XRayVaultData -> XRaySegment -> IO ()

Add subsegment to XRay vault data IORef.

makeSubsegmentIndependent :: XRayVaultData -> XRaySegment -> XRaySegment

Uses the trace ID and segment ID of the root segment from the vault to make a subsegment independent. This is useful so nested components that create subsegments don't need all of this information threaded down to them. We can just decorate all of the subsegments with it before sending them off.

module Network.AWS.XRayClient.TraceId

module Network.AWS.XRayClient.SendSegments

module Network.AWS.XRayClient.Segment