{-# LANGUAGE RankNTypes #-}
module Ecluse.Runtime.Telemetry.Tracing.Internal (
telemetryWaiMiddleware,
dataPlaneTrace,
tracedExchange,
withRuleEvalSpan,
withMirrorEnqueueSpan,
withMirrorJobSpan,
withAdvisorySyncSpan,
JobSpanOutcome (..),
tracingPortOf,
workerTracingPortOf,
advisorySyncTracingPortOf,
ruleVerdictFields,
) where
import Network.HTTP.Client (HttpException (HttpExceptionRequest, InvalidUrlException))
import Network.Wai (Middleware)
import OpenTelemetry.Instrumentation.HttpClient (
HttpClientInstrumentationConfig (httpClientMetrics),
httpClientInstrumentationConfig,
tracedHttpRequest,
)
import OpenTelemetry.Instrumentation.HttpClient.Raw (createHttpClientMetricsFromMeter)
import OpenTelemetry.Instrumentation.Wai (newOpenTelemetryWaiMiddleware')
import OpenTelemetry.Metric.Core (getMeter)
import OpenTelemetry.Propagator.W3CTraceContext (decodeSpanContext, encodeSpanContext)
import OpenTelemetry.Trace (
NewLink (NewLink, linkAttributes, linkContext),
Span,
SpanArguments (kind, links),
SpanKind (Client, Consumer, Internal, Producer),
SpanStatus (Error),
addAttribute,
defaultSpanArguments,
inSpan',
makeTracer,
setStatus,
tracerOptions,
)
import Text.Show (showParen, showString, shows, showsPrec)
import UnliftIO (MonadUnliftIO, withRunInIO)
import UnliftIO.Exception (catch, mask, throwIO, withException)
import Ecluse.Core.Cve.Types (OsvDbFetchFault, renderOsvDbFetchFault)
import Ecluse.Core.Ecosystem (Ecosystem, ecosystemName)
import Ecluse.Core.Package (PackageName, renderPackageName)
import Ecluse.Core.Queue (RemoteSpanContext (RemoteSpanContext, rscTraceparent, rscTracestate))
import Ecluse.Core.Registry.Exchange.Types (TraceExchange, untracedExchange)
import Ecluse.Core.Security.Authority (authorityLabel)
import Ecluse.Core.Server.Response (
RejectReason (BelowIntegrityFloor, ByPolicy, MissingIntegrity, Unavailable, UpstreamInvalid),
Rejection (rejectionMessage, rejectionReason),
RuleName (RuleName),
ServeDecision (Admit, Reject),
)
import Ecluse.Core.Telemetry.Metrics (AdvisorySyncResult, advisorySyncResultName)
import Ecluse.Core.Telemetry.Span (AdvisorySyncTracingPort (..), JobSpanOutcome (..), TracingPort (..), WorkerTracingPort (..), ecluseScope)
import Ecluse.Core.Version (Version, renderVersion)
import Ecluse.Runtime.Telemetry (
Telemetry,
telemetryMeterProvider,
telemetryTracerProvider,
)
import Ecluse.Runtime.Telemetry.Escape (escapeRecordingMiddleware, recordEscape)
telemetryWaiMiddleware :: Telemetry -> IO Middleware
telemetryWaiMiddleware :: Telemetry -> IO Middleware
telemetryWaiMiddleware Telemetry
telemetry =
case (Telemetry -> Maybe TracerProvider
telemetryTracerProvider Telemetry
telemetry, Telemetry -> Maybe MeterProvider
telemetryMeterProvider Telemetry
telemetry) of
(Just TracerProvider
tracerProvider, Just MeterProvider
meterProvider) -> do
meter <- MeterProvider -> InstrumentationLibrary -> IO Meter
getMeter MeterProvider
meterProvider InstrumentationLibrary
forall s. IsString s => s
ecluseScope
(. escapeRecordingMiddleware) <$> newOpenTelemetryWaiMiddleware' tracerProvider meter
(Maybe TracerProvider, Maybe MeterProvider)
_ -> Middleware -> IO Middleware
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure Middleware
forall a. a -> a
id
dataPlaneTrace :: Telemetry -> IO TraceExchange
dataPlaneTrace :: Telemetry -> IO TraceExchange
dataPlaneTrace Telemetry
telemetry =
case (Telemetry -> Maybe TracerProvider
telemetryTracerProvider Telemetry
telemetry, Telemetry -> Maybe MeterProvider
telemetryMeterProvider Telemetry
telemetry) of
(Just TracerProvider
_, Just MeterProvider
meterProvider) -> do
metrics <- Meter -> IO HttpClientMetrics
createHttpClientMetricsFromMeter (Meter -> IO HttpClientMetrics) -> IO Meter -> IO HttpClientMetrics
forall (m :: * -> *) a b. Monad m => (a -> m b) -> m a -> m b
=<< MeterProvider -> InstrumentationLibrary -> IO Meter
getMeter MeterProvider
meterProvider InstrumentationLibrary
"hs-opentelemetry-instrumentation-http-client"
pure (tracedExchange httpClientInstrumentationConfig{httpClientMetrics = Just metrics})
(Maybe TracerProvider, Maybe MeterProvider)
_ -> TraceExchange -> IO TraceExchange
forall a. a -> IO a
forall (f :: * -> *) a. Applicative f => a -> f a
pure TraceExchange
untracedExchange
tracedExchange :: HttpClientInstrumentationConfig -> TraceExchange
tracedExchange :: HttpClientInstrumentationConfig -> TraceExchange
tracedExchange HttpClientInstrumentationConfig
config Request
request Request -> IO (Response BodyReader)
open =
((forall a. IO a -> IO a) -> IO (Response BodyReader))
-> IO (Response BodyReader)
forall (m :: * -> *) b.
MonadUnliftIO m =>
((forall a. m a -> m a) -> m b) -> m b
mask (((forall a. IO a -> IO a) -> IO (Response BodyReader))
-> IO (Response BodyReader))
-> ((forall a. IO a -> IO a) -> IO (Response BodyReader))
-> IO (Response BodyReader)
forall a b. (a -> b) -> a -> b
$ \forall a. IO a -> IO a
restore ->
HttpClientInstrumentationConfig -> TraceExchange
forall a.
HttpClientInstrumentationConfig
-> Request -> (Request -> IO (Response a)) -> IO (Response a)
tracedHttpRequest HttpClientInstrumentationConfig
config Request
request (\Request
sent -> IO (Response BodyReader) -> IO (Response BodyReader)
forall a. IO a -> IO a
restore (Request -> IO (Response BodyReader)
open Request
sent) IO (Response BodyReader)
-> (HttpException -> IO (Response BodyReader))
-> IO (Response BodyReader)
forall (m :: * -> *) e a.
(MonadUnliftIO m, Exception e) =>
m a -> (e -> m a) -> m a
`catch` (UntaggedFault -> IO (Response BodyReader)
forall (m :: * -> *) e a. (MonadIO m, Exception e) => e -> m a
throwIO (UntaggedFault -> IO (Response BodyReader))
-> (HttpException -> UntaggedFault)
-> HttpException
-> IO (Response BodyReader)
forall b c a. (b -> c) -> (a -> b) -> a -> c
. HttpException -> UntaggedFault
UntaggedFault))
IO (Response BodyReader)
-> (UntaggedFault -> IO (Response BodyReader))
-> IO (Response BodyReader)
forall (m :: * -> *) e a.
(MonadUnliftIO m, Exception e) =>
m a -> (e -> m a) -> m a
`catch` \(UntaggedFault HttpException
original) -> HttpException -> IO (Response BodyReader)
forall (m :: * -> *) e a. (MonadIO m, Exception e) => e -> m a
throwIO HttpException
original
newtype UntaggedFault = UntaggedFault HttpException
instance Show UntaggedFault where
showsPrec :: Int -> UntaggedFault -> ShowS
showsPrec Int
precedence (UntaggedFault HttpException
fault) = case HttpException
fault of
HttpExceptionRequest Request
_ HttpExceptionContent
content ->
Bool -> ShowS -> ShowS
showParen (Int
precedence Int -> Int -> Bool
forall a. Ord a => a -> a -> Bool
>= Int
11) (String -> ShowS
showString String
"HttpExceptionContentWrapper {unHttpExceptionContentWrapper = " ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. HttpExceptionContent -> ShowS
forall a. Show a => a -> ShowS
shows HttpExceptionContent
content ShowS -> ShowS -> ShowS
forall b c a. (b -> c) -> (a -> b) -> a -> c
. String -> ShowS
showString String
"}")
InvalidUrlException{} -> Int -> HttpException -> ShowS
forall a. Show a => Int -> a -> ShowS
showsPrec Int
precedence HttpException
fault
instance Exception UntaggedFault
withRuleEvalSpan ::
(MonadUnliftIO m) =>
Telemetry ->
PackageName ->
Version ->
m (a, ServeDecision) ->
m a
withRuleEvalSpan :: forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry -> PackageName -> Version -> m (a, ServeDecision) -> m a
withRuleEvalSpan Telemetry
telemetry PackageName
name Version
version m (a, ServeDecision)
action =
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
Internal [] Text
"ecluse.rule.eval" ((Maybe Span -> m a) -> m a) -> (Maybe Span -> m a) -> m a
forall a b. (a -> b) -> a -> b
$ \Maybe Span
mSpan -> do
Maybe Span -> [(Text, Text)] -> m ()
forall (m :: * -> *).
MonadIO m =>
Maybe Span -> [(Text, Text)] -> m ()
recordFields Maybe Span
mSpan (PackageName -> Version -> [(Text, Text)]
coordinateFields PackageName
name Version
version)
(result, verdict) <- m (a, ServeDecision)
action
recordFields mSpan (ruleVerdictFields verdict)
pure result
withMirrorEnqueueSpan ::
(MonadUnliftIO m) =>
Telemetry ->
PackageName ->
Version ->
Text ->
(a -> Maybe Text) ->
(Maybe RemoteSpanContext -> m a) ->
m a
withMirrorEnqueueSpan :: forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> PackageName
-> Version
-> Text
-> (a -> Maybe Text)
-> (Maybe RemoteSpanContext -> m a)
-> m a
withMirrorEnqueueSpan Telemetry
telemetry PackageName
name Version
version Text
artifactUrl a -> Maybe Text
project Maybe RemoteSpanContext -> m a
body =
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
Producer [] Text
"ecluse.mirror.enqueue" ((Maybe Span -> m a) -> m a) -> (Maybe Span -> m a) -> m a
forall a b. (a -> b) -> a -> b
$ \Maybe Span
mSpan -> do
Maybe Span -> [(Text, Text)] -> m ()
forall (m :: * -> *).
MonadIO m =>
Maybe Span -> [(Text, Text)] -> m ()
recordFields Maybe Span
mSpan (PackageName -> Version -> [(Text, Text)]
coordinateFields PackageName
name Version
version [(Text, Text)] -> [(Text, Text)] -> [(Text, Text)]
forall a. Semigroup a => a -> a -> a
<> [(Text
"ecluse.mirror.artifact_host", Text -> Text
authorityLabel Text
artifactUrl)])
carrier <- (Span -> m RemoteSpanContext)
-> Maybe Span -> m (Maybe RemoteSpanContext)
forall (t :: * -> *) (f :: * -> *) a b.
(Traversable t, Applicative f) =>
(a -> f b) -> t a -> f (t b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> Maybe a -> f (Maybe b)
traverse Span -> m RemoteSpanContext
forall (m :: * -> *). MonadIO m => Span -> m RemoteSpanContext
captureRemoteContext Maybe Span
mSpan
result <- body carrier
whenJust mSpan $ \Span
theSpan -> Maybe Text -> (Text -> m ()) -> m ()
forall (f :: * -> *) a.
Applicative f =>
Maybe a -> (a -> f ()) -> f ()
whenJust (a -> Maybe Text
project a
result) (Span -> SpanStatus -> m ()
forall (m :: * -> *). MonadIO m => Span -> SpanStatus -> m ()
setStatus Span
theSpan (SpanStatus -> m ()) -> (Text -> SpanStatus) -> Text -> m ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> SpanStatus
Error)
pure result
withMirrorJobSpan ::
(MonadUnliftIO m) =>
Telemetry ->
PackageName ->
Version ->
Maybe RemoteSpanContext ->
(a -> JobSpanOutcome) ->
m a ->
m a
withMirrorJobSpan :: forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> PackageName
-> Version
-> Maybe RemoteSpanContext
-> (a -> JobSpanOutcome)
-> m a
-> m a
withMirrorJobSpan Telemetry
telemetry PackageName
name Version
version Maybe RemoteSpanContext
remoteContext a -> JobSpanOutcome
project m a
action =
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
Consumer (Maybe RemoteSpanContext -> [NewLink]
mirrorJobLinks Maybe RemoteSpanContext
remoteContext) Text
"ecluse.mirror.job" ((Maybe Span -> m a) -> m a) -> (Maybe Span -> m a) -> m a
forall a b. (a -> b) -> a -> b
$ \Maybe Span
mSpan -> do
Maybe Span -> [(Text, Text)] -> m ()
forall (m :: * -> *).
MonadIO m =>
Maybe Span -> [(Text, Text)] -> m ()
recordFields Maybe Span
mSpan (PackageName -> Version -> [(Text, Text)]
coordinateFields PackageName
name Version
version)
result <- m a
action
let JobSpanOutcome label mDetail = project result
recordFields mSpan [("ecluse.mirror.outcome", label)]
whenJust mSpan $ \Span
theSpan -> Maybe Text -> (Text -> m ()) -> m ()
forall (f :: * -> *) a.
Applicative f =>
Maybe a -> (a -> f ()) -> f ()
whenJust Maybe Text
mDetail (Span -> SpanStatus -> m ()
forall (m :: * -> *). MonadIO m => Span -> SpanStatus -> m ()
setStatus Span
theSpan (SpanStatus -> m ()) -> (Text -> SpanStatus) -> Text -> m ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> SpanStatus
Error)
pure result
withAdvisorySyncSpan ::
(MonadUnliftIO m) =>
Telemetry ->
Ecosystem ->
(a -> (AdvisorySyncResult, Maybe OsvDbFetchFault)) ->
m a ->
m a
withAdvisorySyncSpan :: forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> Ecosystem
-> (a -> (AdvisorySyncResult, Maybe OsvDbFetchFault))
-> m a
-> m a
withAdvisorySyncSpan Telemetry
telemetry Ecosystem
eco a -> (AdvisorySyncResult, Maybe OsvDbFetchFault)
project m a
action =
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
Internal [] Text
"ecluse.advisory.sync.attempt" ((Maybe Span -> m a) -> m a) -> (Maybe Span -> m a) -> m a
forall a b. (a -> b) -> a -> b
$ \Maybe Span
mSpan -> do
Maybe Span -> [(Text, Text)] -> m ()
forall (m :: * -> *).
MonadIO m =>
Maybe Span -> [(Text, Text)] -> m ()
recordFields Maybe Span
mSpan [(Text
"ecluse.ecosystem", Ecosystem -> Text
ecosystemName Ecosystem
eco)]
result <- m a
action
let (outcome, failure) = project result
recordFields mSpan [("ecluse.advisory.sync.result", advisorySyncResultName outcome)]
whenJust mSpan $ \Span
theSpan -> Maybe OsvDbFetchFault -> (OsvDbFetchFault -> m ()) -> m ()
forall (f :: * -> *) a.
Applicative f =>
Maybe a -> (a -> f ()) -> f ()
whenJust Maybe OsvDbFetchFault
failure (Span -> SpanStatus -> m ()
forall (m :: * -> *). MonadIO m => Span -> SpanStatus -> m ()
setStatus Span
theSpan (SpanStatus -> m ())
-> (OsvDbFetchFault -> SpanStatus) -> OsvDbFetchFault -> m ()
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Text -> SpanStatus
Error (Text -> SpanStatus)
-> (OsvDbFetchFault -> Text) -> OsvDbFetchFault -> SpanStatus
forall b c a. (b -> c) -> (a -> b) -> a -> c
. OsvDbFetchFault -> Text
renderOsvDbFetchFault)
pure result
withPackageSpan :: (MonadUnliftIO m) => Telemetry -> SpanKind -> Text -> PackageName -> m a -> m a
withPackageSpan :: forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry -> SpanKind -> Text -> PackageName -> m a -> m a
withPackageSpan Telemetry
telemetry SpanKind
spanKind Text
spanName PackageName
name m a
action =
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
spanKind [] Text
spanName ((Maybe Span -> m a) -> m a) -> (Maybe Span -> m a) -> m a
forall a b. (a -> b) -> a -> b
$ \Maybe Span
mSpan -> do
Maybe Span -> [(Text, Text)] -> m ()
forall (m :: * -> *).
MonadIO m =>
Maybe Span -> [(Text, Text)] -> m ()
recordFields Maybe Span
mSpan [(Text
"ecluse.package", PackageName -> Text
renderPackageName PackageName
name)]
m a
action
tracingPortOf :: Telemetry -> TracingPort
tracingPortOf :: Telemetry -> TracingPort
tracingPortOf Telemetry
telemetry =
TracingPort
{ spanRuleEval :: forall a. PackageName -> Version -> IO (a, ServeDecision) -> IO a
spanRuleEval = Telemetry
-> PackageName -> Version -> IO (a, ServeDecision) -> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry -> PackageName -> Version -> m (a, ServeDecision) -> m a
withRuleEvalSpan Telemetry
telemetry
, spanMirrorEnqueue :: forall a.
PackageName
-> Version
-> Text
-> (a -> Maybe Text)
-> (Maybe RemoteSpanContext -> IO a)
-> IO a
spanMirrorEnqueue = \PackageName
n Version
v Text
url a -> Maybe Text
ok Maybe RemoteSpanContext -> IO a
action -> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall b. ((forall a. IO a -> IO a) -> IO b) -> IO b
forall (m :: * -> *) b.
MonadUnliftIO m =>
((forall a. m a -> IO a) -> IO b) -> m b
withRunInIO (((forall a. IO a -> IO a) -> IO a) -> IO a)
-> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall a b. (a -> b) -> a -> b
$ \forall a. IO a -> IO a
runInIO ->
Telemetry
-> PackageName
-> Version
-> Text
-> (a -> Maybe Text)
-> (Maybe RemoteSpanContext -> IO a)
-> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> PackageName
-> Version
-> Text
-> (a -> Maybe Text)
-> (Maybe RemoteSpanContext -> m a)
-> m a
withMirrorEnqueueSpan Telemetry
telemetry PackageName
n Version
v Text
url a -> Maybe Text
ok (IO a -> IO a
forall a. IO a -> IO a
runInIO (IO a -> IO a)
-> (Maybe RemoteSpanContext -> IO a)
-> Maybe RemoteSpanContext
-> IO a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Maybe RemoteSpanContext -> IO a
action)
, spanPackumentGate :: forall a. PackageName -> IO a -> IO a
spanPackumentGate = \PackageName
n IO a
action -> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall b. ((forall a. IO a -> IO a) -> IO b) -> IO b
forall (m :: * -> *) b.
MonadUnliftIO m =>
((forall a. m a -> IO a) -> IO b) -> m b
withRunInIO (((forall a. IO a -> IO a) -> IO a) -> IO a)
-> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall a b. (a -> b) -> a -> b
$ \forall a. IO a -> IO a
runInIO ->
Telemetry -> SpanKind -> Text -> PackageName -> IO a -> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry -> SpanKind -> Text -> PackageName -> m a -> m a
withPackageSpan Telemetry
telemetry SpanKind
Internal Text
"ecluse.packument.gate" PackageName
n (IO a -> IO a
forall a. IO a -> IO a
runInIO IO a
action)
, spanMetadataFetch :: forall a. PackageName -> IO a -> IO a
spanMetadataFetch = \PackageName
n IO a
action -> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall b. ((forall a. IO a -> IO a) -> IO b) -> IO b
forall (m :: * -> *) b.
MonadUnliftIO m =>
((forall a. m a -> IO a) -> IO b) -> m b
withRunInIO (((forall a. IO a -> IO a) -> IO a) -> IO a)
-> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall a b. (a -> b) -> a -> b
$ \forall a. IO a -> IO a
runInIO ->
Telemetry -> SpanKind -> Text -> PackageName -> IO a -> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry -> SpanKind -> Text -> PackageName -> m a -> m a
withPackageSpan Telemetry
telemetry SpanKind
Client Text
metadataFetchSpan PackageName
n (IO a -> IO a
forall a. IO a -> IO a
runInIO IO a
action)
, spanMetadataDecode :: forall a. PackageName -> IO a -> IO a
spanMetadataDecode = \PackageName
n IO a
action -> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall b. ((forall a. IO a -> IO a) -> IO b) -> IO b
forall (m :: * -> *) b.
MonadUnliftIO m =>
((forall a. m a -> IO a) -> IO b) -> m b
withRunInIO (((forall a. IO a -> IO a) -> IO a) -> IO a)
-> ((forall a. IO a -> IO a) -> IO a) -> IO a
forall a b. (a -> b) -> a -> b
$ \forall a. IO a -> IO a
runInIO ->
Telemetry -> SpanKind -> Text -> PackageName -> IO a -> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry -> SpanKind -> Text -> PackageName -> m a -> m a
withPackageSpan Telemetry
telemetry SpanKind
Internal Text
metadataDecodeSpan PackageName
n (IO a -> IO a
forall a. IO a -> IO a
runInIO IO a
action)
, spanDirectoryFetch :: forall a. IO a -> IO a
spanDirectoryFetch = Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> IO a) -> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
Client [] Text
metadataFetchSpan ((Maybe Span -> IO a) -> IO a)
-> (IO a -> Maybe Span -> IO a) -> IO a -> IO a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. IO a -> Maybe Span -> IO a
forall a b. a -> b -> a
const
, spanDirectoryDecode :: forall a. IO a -> IO a
spanDirectoryDecode = Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> IO a) -> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
Internal [] Text
metadataDecodeSpan ((Maybe Span -> IO a) -> IO a)
-> (IO a -> Maybe Span -> IO a) -> IO a -> IO a
forall b c a. (b -> c) -> (a -> b) -> a -> c
. IO a -> Maybe Span -> IO a
forall a b. a -> b -> a
const
}
metadataFetchSpan, metadataDecodeSpan :: Text
metadataFetchSpan :: Text
metadataFetchSpan = Text
"ecluse.metadata.fetch"
metadataDecodeSpan :: Text
metadataDecodeSpan = Text
"ecluse.metadata.decode"
workerTracingPortOf :: Telemetry -> WorkerTracingPort
workerTracingPortOf :: Telemetry -> WorkerTracingPort
workerTracingPortOf Telemetry
telemetry =
WorkerTracingPort
{ wtpMirrorJobSpan :: forall a.
PackageName
-> Version
-> Maybe RemoteSpanContext
-> (a -> JobSpanOutcome)
-> IO a
-> IO a
wtpMirrorJobSpan = Telemetry
-> PackageName
-> Version
-> Maybe RemoteSpanContext
-> (a -> JobSpanOutcome)
-> IO a
-> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> PackageName
-> Version
-> Maybe RemoteSpanContext
-> (a -> JobSpanOutcome)
-> m a
-> m a
withMirrorJobSpan Telemetry
telemetry
}
advisorySyncTracingPortOf :: Telemetry -> AdvisorySyncTracingPort
advisorySyncTracingPortOf :: Telemetry -> AdvisorySyncTracingPort
advisorySyncTracingPortOf Telemetry
telemetry =
AdvisorySyncTracingPort
{ astpSyncAttemptSpan :: forall a.
Ecosystem
-> (a -> (AdvisorySyncResult, Maybe OsvDbFetchFault))
-> IO a
-> IO a
astpSyncAttemptSpan = Telemetry
-> Ecosystem
-> (a -> (AdvisorySyncResult, Maybe OsvDbFetchFault))
-> IO a
-> IO a
forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> Ecosystem
-> (a -> (AdvisorySyncResult, Maybe OsvDbFetchFault))
-> m a
-> m a
withAdvisorySyncSpan Telemetry
telemetry
}
ruleVerdictFields :: ServeDecision -> [(Text, Text)]
ruleVerdictFields :: ServeDecision -> [(Text, Text)]
ruleVerdictFields = \case
ServeDecision
Admit -> [(Text
"ecluse.rule.decision", Text
"admit")]
Reject Rejection
rejection ->
[ (Text
"ecluse.rule.decision", Text
"deny")
, (Text
"ecluse.rule.reason_class", RejectReason -> Text
reasonClass (Rejection -> RejectReason
rejectionReason Rejection
rejection))
, (Text
"ecluse.rule.message", Rejection -> Text
rejectionMessage Rejection
rejection)
]
[(Text, Text)] -> [(Text, Text)] -> [(Text, Text)]
forall a. Semigroup a => a -> a -> a
<> RejectReason -> [(Text, Text)]
ruleNameField (Rejection -> RejectReason
rejectionReason Rejection
rejection)
reasonClass :: RejectReason -> Text
reasonClass :: RejectReason -> Text
reasonClass = \case
ByPolicy{} -> Text
"by_policy"
Unavailable Transience
_ -> Text
"unavailable"
RejectReason
MissingIntegrity -> Text
"missing_integrity"
RejectReason
BelowIntegrityFloor -> Text
"below_integrity_floor"
RejectReason
UpstreamInvalid -> Text
"upstream_invalid"
ruleNameField :: RejectReason -> [(Text, Text)]
ruleNameField :: RejectReason -> [(Text, Text)]
ruleNameField = \case
ByPolicy (RuleName Text
ruleName) [Reason]
_ -> [(Text
"ecluse.rule.name", Text
ruleName)]
Unavailable Transience
_ -> []
RejectReason
MissingIntegrity -> []
RejectReason
BelowIntegrityFloor -> []
RejectReason
UpstreamInvalid -> []
withDomainSpan ::
(MonadUnliftIO m) =>
Telemetry ->
SpanKind ->
[NewLink] ->
Text ->
(Maybe Span -> m a) ->
m a
withDomainSpan :: forall (m :: * -> *) a.
MonadUnliftIO m =>
Telemetry
-> SpanKind -> [NewLink] -> Text -> (Maybe Span -> m a) -> m a
withDomainSpan Telemetry
telemetry SpanKind
spanKind [NewLink]
spanLinks Text
name Maybe Span -> m a
body =
case Telemetry -> Maybe TracerProvider
telemetryTracerProvider Telemetry
telemetry of
Maybe TracerProvider
Nothing -> Maybe Span -> m a
body Maybe Span
forall a. Maybe a
Nothing
Just TracerProvider
tracerProvider ->
let tracer :: Tracer
tracer = TracerProvider -> InstrumentationLibrary -> TracerOptions -> Tracer
makeTracer TracerProvider
tracerProvider InstrumentationLibrary
forall s. IsString s => s
ecluseScope TracerOptions
tracerOptions
in Tracer -> Text -> SpanArguments -> (Span -> m a) -> m a
forall (m :: * -> *) a.
(MonadUnliftIO m, HasCallStack) =>
Tracer -> Text -> SpanArguments -> (Span -> m a) -> m a
inSpan' Tracer
tracer Text
name SpanArguments
defaultSpanArguments{kind = spanKind, links = spanLinks} ((Span -> m a) -> m a) -> (Span -> m a) -> m a
forall a b. (a -> b) -> a -> b
$ \Span
theSpan ->
Maybe Span -> m a
body (Span -> Maybe Span
forall a. a -> Maybe a
Just Span
theSpan) m a -> (SomeException -> m ()) -> m a
forall (m :: * -> *) e a b.
(MonadUnliftIO m, Exception e) =>
m a -> (e -> m b) -> m a
`withException` Span -> SomeException -> m ()
forall (m :: * -> *). MonadIO m => Span -> SomeException -> m ()
recordEscape Span
theSpan
captureRemoteContext :: (MonadIO m) => Span -> m RemoteSpanContext
captureRemoteContext :: forall (m :: * -> *). MonadIO m => Span -> m RemoteSpanContext
captureRemoteContext Span
theSpan = do
(traceparent, tracestate) <- IO (ByteString, ByteString) -> m (ByteString, ByteString)
forall a. IO a -> m a
forall (m :: * -> *) a. MonadIO m => IO a -> m a
liftIO (Span -> IO (ByteString, ByteString)
encodeSpanContext Span
theSpan)
pure
RemoteSpanContext
{ rscTraceparent = decodeUtf8 traceparent
, rscTracestate = decodeUtf8 tracestate
}
mirrorJobLinks :: Maybe RemoteSpanContext -> [NewLink]
mirrorJobLinks :: Maybe RemoteSpanContext -> [NewLink]
mirrorJobLinks Maybe RemoteSpanContext
Nothing = []
mirrorJobLinks (Just RemoteSpanContext
remote) =
case Maybe ByteString -> Maybe ByteString -> Maybe SpanContext
decodeSpanContext (ByteString -> Maybe ByteString
forall a. a -> Maybe a
Just (Text -> ByteString
forall a b. ConvertUtf8 a b => a -> b
encodeUtf8 (RemoteSpanContext -> Text
rscTraceparent RemoteSpanContext
remote))) Maybe ByteString
tracestateHeader of
Maybe SpanContext
Nothing -> []
Just SpanContext
ctx -> [NewLink{linkContext :: SpanContext
linkContext = SpanContext
ctx, linkAttributes :: AttributeMap
linkAttributes = AttributeMap
forall a. Monoid a => a
mempty}]
where
tracestateHeader :: Maybe ByteString
tracestateHeader :: Maybe ByteString
tracestateHeader
| RemoteSpanContext -> Text
rscTracestate RemoteSpanContext
remote Text -> Text -> Bool
forall a. Eq a => a -> a -> Bool
== Text
"" = Maybe ByteString
forall a. Maybe a
Nothing
| Bool
otherwise = ByteString -> Maybe ByteString
forall a. a -> Maybe a
Just (Text -> ByteString
forall a b. ConvertUtf8 a b => a -> b
encodeUtf8 (RemoteSpanContext -> Text
rscTracestate RemoteSpanContext
remote))
recordFields :: (MonadIO m) => Maybe Span -> [(Text, Text)] -> m ()
recordFields :: forall (m :: * -> *).
MonadIO m =>
Maybe Span -> [(Text, Text)] -> m ()
recordFields Maybe Span
Nothing [(Text, Text)]
_ = m ()
forall (f :: * -> *). Applicative f => f ()
pass
recordFields (Just Span
theSpan) [(Text, Text)]
fields = ((Text, Text) -> m ()) -> [(Text, Text)] -> m ()
forall (t :: * -> *) (f :: * -> *) a b.
(Foldable t, Applicative f) =>
(a -> f b) -> t a -> f ()
traverse_ ((Text -> Text -> m ()) -> (Text, Text) -> m ()
forall a b c. (a -> b -> c) -> (a, b) -> c
uncurry (Span -> Text -> Text -> m ()
forall (m :: * -> *) a.
(MonadIO m, ToAttribute a) =>
Span -> Text -> a -> m ()
addAttribute Span
theSpan)) [(Text, Text)]
fields
coordinateFields :: PackageName -> Version -> [(Text, Text)]
coordinateFields :: PackageName -> Version -> [(Text, Text)]
coordinateFields PackageName
name Version
version =
[ (Text
"ecluse.package", PackageName -> Text
renderPackageName PackageName
name)
, (Text
"ecluse.version", Version -> Text
renderVersion Version
version)
]