cachix · sandydoo · Sep 26, 2023 · Sep 27, 2023
diff --git a/cachix/cachix-deployment/Main.hs b/cachix/cachix-deployment/Main.hs
@@ -1,4 +1,6 @@
 {-# LANGUAGE DuplicateRecordFields #-}
+{-# LANGUAGE OverloadedLists #-}
+{-# LANGUAGE TypeApplications #-}
 
 module Main
   ( main,
@@ -27,6 +29,7 @@ import qualified Data.UUID.V4 as UUID
 import GHC.IO.Encoding
 import qualified Katip as K
 import qualified Network.WebSockets as WS
+import OpenTelemetry.Trace
 import Protolude hiding (toS)
 import Protolude.Conv
 import System.IO (BufferMode (..), hSetBuffering)
@@ -45,52 +48,67 @@ main = do
   hSetBuffering stdout LineBuffering
   hSetBuffering stderr LineBuffering
 
-  deployment@Deployment
-    { agentName,
-      agentToken,
-      host,
-      logOptions,
-      deploymentDetails
-    } <-
-    escalateAs (FatalError . toS) . Aeson.eitherDecode . toS =<< getContents
-
-  let deploymentID = DeploymentDetails.id deploymentDetails
-  let headers = WebSocket.createHeaders agentName agentToken
-  let port = fromMaybe (URI.Port 80) (URI.getPortFor (URI.getScheme host))
-  let logWebsocketOptions =
-        WebSocket.Options
-          { WebSocket.host = URI.getHostname host,
-            WebSocket.port = port,
-            WebSocket.path = "/api/v1/deploy/log/" <> UUID.toText deploymentID,
-            WebSocket.useSSL = URI.requiresSSL (URI.getScheme host),
-            WebSocket.headers = headers,
-            WebSocket.identifier = Agent.agentIdentifier agentName
-          }
-  let serviceWebsocketOptions =
-        WebSocket.Options
-          { WebSocket.host = URI.getHostname host,
-            WebSocket.port = port,
-            WebSocket.path = "/ws-deployment",
-            WebSocket.useSSL = URI.requiresSSL (URI.getScheme host),
-            WebSocket.headers = headers,
-            WebSocket.identifier = Agent.agentIdentifier agentName
-          }
+  withTracer $ \tracer ->
+    inSpan' tracer "deployment" defaultSpanArguments $ \span -> do
+      deployment@Deployment
+        { agentName,
+          agentToken,
+          agentInformation,
+          profileName,
+          host,
+          logOptions,
+          deploymentDetails
+        } <-
+        escalateAs (FatalError . toS) . Aeson.eitherDecode . toS =<< getContents
+
+      let deploymentID = DeploymentDetails.id deploymentDetails
+      let headers = WebSocket.createHeaders agentName agentToken
+      let port = fromMaybe (URI.Port 80) (URI.getPortFor (URI.getScheme host))
+      let logWebsocketOptions =
+            WebSocket.Options
+              { WebSocket.host = URI.getHostname host,
+                WebSocket.port = port,
+                WebSocket.path = "/api/v1/deploy/log/" <> UUID.toText deploymentID,
+                WebSocket.useSSL = URI.requiresSSL (URI.getScheme host),
+                WebSocket.headers = headers,
+                WebSocket.identifier = Agent.agentIdentifier agentName
+              }
+      let serviceWebsocketOptions =
+            WebSocket.Options
+              { WebSocket.host = URI.getHostname host,
+                WebSocket.port = port,
+                WebSocket.path = "/ws-deployment",
+                WebSocket.useSSL = URI.requiresSSL (URI.getScheme host),
+                WebSocket.headers = headers,
+                WebSocket.identifier = Agent.agentIdentifier agentName
+              }
 
-  Log.withLog logOptions $ \withLog ->
-    void . Lock.withTryLock (lockFilename agentName) $ do
-      -- Open a connection to logging stream
-      (logQueue, loggingThread) <- runLogStream withLog logWebsocketOptions
+      addAttributes
+        span
+        [ ("cachix.deploy.agent.id", toAttribute $ UUID.toText $ AgentInformation.id agentInformation),
+          ("cachix.deploy.agent.name", toAttribute agentName),
+          ("cachix.deploy.deployment.id", toAttribute $ UUID.toText deploymentID),
+          ("cachix.deploy.deployment.index", toAttribute $ DeploymentDetails.index deploymentDetails),
+          ("cachix.deploy.deployment.store_path", toAttribute $ DeploymentDetails.storePath deploymentDetails),
+          ("cachix.deploy.deployment.profile_name", toAttribute profileName),
+          ("cachix.deploy.host", toAttribute $ URI.serialize @Text host)
+        ]
 
-      -- Open a connection to Cachix and block until it's ready.
-      service <- WebSocket.new withLog serviceWebsocketOptions
-      shutdownService <- Agent.connectToService service
+      Log.withLog logOptions $ \withLog ->
+        void . Lock.withTryLock (lockFilename agentName) $ do
+          -- Open a connection to logging stream
+          (logQueue, loggingThread) <- runLogStream withLog logWebsocketOptions
 
-      deploy withLog deployment service (Conduit.sinkTMQueue logQueue)
-        `finally` do
-          withLog $ K.logLocM K.DebugS "Cleaning up websocket connections"
-          atomically $ TMQueue.closeTMQueue logQueue
-          shutdownService
-          Async.wait loggingThread
+          -- Open a connection to Cachix and block until it's ready.
+          service <- WebSocket.new withLog serviceWebsocketOptions
+          shutdownService <- Agent.connectToService service
+
+          deploy withLog deployment service (Conduit.sinkTMQueue logQueue) span
+            `finally` do
+              withLog $ K.logLocM K.DebugS "Cleaning up websocket connections"
+              atomically $ TMQueue.closeTMQueue logQueue
+              shutdownService
+              Async.wait loggingThread
 
 -- | Run the deployment commands
 deploy ::
@@ -101,8 +119,9 @@ deploy ::
   Agent.ServiceWebSocket ->
   -- | Logging Websocket connection
   Log.LogStream ->
+  Span ->
   IO ()
-deploy withLog Deployment {..} service logStream = do
+deploy withLog Deployment {..} service logStream span = do
   withLog $ K.logLocM K.InfoS $ K.ls $ "Deploying #" <> deploymentIndex <> ": " <> storePath
 
   activationStatus <- handleAsActivationStatus $
@@ -155,6 +174,12 @@ deploy withLog Deployment {..} service logStream = do
       -- NOTE: the activate command uses this message to detect the end of the log
       Log.streamLine logStream "Successfully activated the deployment."
       withLog $ K.logLocM K.InfoS $ K.ls $ "Deployment #" <> deploymentIndex <> " finished."
+      addEvent span $
+        NewEvent
+          { newEventName = "cachix.deploy.deployment.result.success",
+            newEventAttributes = mempty,
+            newEventTimestamp = Nothing
+          }
 
   endDeployment activationStatus
   where
@@ -230,6 +255,13 @@ deploy withLog Deployment {..} service logStream = do
           WSS.DeploymentStarted {} -> "DeploymentStarted"
           WSS.DeploymentFinished {} -> "DeploymentFinished"
 
+withTracer :: (Tracer -> IO a) -> IO a
+withTracer f =
+  bracket
+    initializeGlobalTracerProvider
+    shutdownTracerProvider
+    (\tracerProvider -> f $ makeTracer tracerProvider "cachix-deployment" tracerOptions)
+
 -- Log
 
 -- TODO: prepend katip-like format to each line

diff --git a/cachix/cachix.cabal b/cachix/cachix.cabal
@@ -194,6 +194,7 @@ executable .cachix-deployment
     , async
     , cachix
     , cachix-api
+    , hs-opentelemetry-sdk
     , katip
     , protolude
     , safe-exceptions

diff --git a/stack.yaml b/stack.yaml
@@ -9,6 +9,15 @@ extra-deps:
 - nix-narinfo-0.1.0.1
 - hnix-store-core-0.6.1.0
 - algebraic-graphs-0.6.1
+# OpenTelemetry dependencies
+- hs-opentelemetry-exporter-otlp-0.0.1.5
+- hs-opentelemetry-sdk-0.0.3.6
+- hs-opentelemetry-api-0.1.0.0
+- hs-opentelemetry-otlp-0.0.1.0
+- hs-opentelemetry-propagator-b3-0.0.1.1
+- hs-opentelemetry-propagator-w3c-0.0.1.3
+- thread-utils-context-0.3.0.4
+- thread-utils-finalizers-0.1.1.0
 nix:
   enable: true
   pure: false