[CSL-1585] Namespace cardano EKG metrics (#1464)

[CSL-1585] Namespace all the relevant IOHK's EKG metrics

core/Pos/System/Metrics/Constants.hs

@@ -0,0 +1,12 @@
+module Pos.System.Metrics.Constants (
+      cardanoNamespace
+    , withCardanoNamespace
+                                        ) where
+
+import           Universum
+
+cardanoNamespace :: Text
+cardanoNamespace = "cardano"
+
+withCardanoNamespace :: Text -> Text
+withCardanoNamespace label = cardanoNamespace <> "." <> label

core/cardano-sl-core.cabal

@@ -98,6 +98,8 @@ library
                        Pos.Binary.Core.Version
                        Pos.Binary.Core.Genesis
 
+                       Pos.System.Metrics.Constants
+
                        Pos.Util.Arbitrary
                        Pos.Util.Concurrent
                        Pos.Util.Concurrent.LockedTVar

infra/Pos/Network/Types.hs

@@ -1,5 +1,5 @@
+{-# LANGUAGE CPP                       #-}
 {-# LANGUAGE ExistentialQuantification #-}
-{-# LANGUAGE CPP #-}
 
 #if !defined(mingw32_HOST_OS)
 #define POSIX
@@ -57,13 +57,14 @@ import           Node.Internal                         (NodeId (..))
 import           Pos.Network.DnsDomains                (DnsDomains (..))
 import qualified Pos.Network.DnsDomains                as DnsDomains
 import qualified Pos.Network.Policy                    as Policy
+import           Pos.System.Metrics.Constants          (cardanoNamespace)
 import           Pos.Util.TimeWarp                     (addressToNodeId)
 import qualified System.Metrics                        as Monitoring
 import           System.Wlog.CanLog                    (WithLogger)
 import           Universum                             hiding (show)
 
 #if !defined(POSIX)
-import qualified Pos.Network.Windows.DnsDomains as Win
+import qualified Pos.Network.Windows.DnsDomains        as Win
 #endif
 
 {-------------------------------------------------------------------------------
@@ -290,7 +291,7 @@ topologyMaxBucketSize topology bucket =
       BucketSubscriptionListener ->
         case topologySubscribers topology of
           Just (_subscriberType, maxBucketSize) -> maxBucketSize
-          Nothing -> OQ.BucketSizeMax 0 -- subscription not allowed
+          Nothing                               -> OQ.BucketSizeMax 0 -- subscription not allowed
       _otherBucket ->
         OQ.BucketSizeUnlimited
 
@@ -339,7 +340,7 @@ initQueue NetworkConfig{..} mStore = do
 
     case mStore of
       Nothing    -> return () -- EKG store not used
-      Just store -> liftIO $ OQ.registerQueueMetrics oq store
+      Just store -> liftIO $ OQ.registerQueueMetrics (Just (toString cardanoNamespace)) oq store
 
     case ncTopology of
       TopologyLightWallet peers -> do

node/cardano-sl.cabal

@@ -113,6 +113,7 @@ library
                         -- Utilities/helpers
                         Pos.Util
                         Pos.Util.LoggerName
+                        Pos.Util.Monitor
                         Pos.Util.Undefined
                         Pos.Util.BackupPhrase
                         Pos.Util.JsonLog
@@ -358,7 +359,7 @@ library
                       , dlist
                       , dns
                       , ed25519
-                      , ekg
+                      , ekg-wai
                       , ekg-core
                       , ekg-statsd
                       , ether >= 0.5

node/src/Pos/Launcher/Runner.hs

@@ -32,11 +32,13 @@ import           Node                            (Node, NodeAction (..), NodeEnd
                                                   node, simpleNodeEndPoint)
 import qualified Node.Conversation               as N (Conversation, Converse,
                                                        converseWith)
-import           Node.Util.Monitor               (setupMonitor, stopMonitor)
+import           Node.Util.Monitor               (registerMetrics)
+import           Pos.System.Metrics.Constants    (cardanoNamespace)
+import           Pos.Util.Monitor                (stopMonitor)
 import qualified System.Metrics                  as Metrics
 import           System.Random                   (newStdGen)
-import qualified System.Remote.Monitoring        as Monitoring
 import qualified System.Remote.Monitoring.Statsd as Monitoring
+import qualified System.Remote.Monitoring.Wai    as Monitoring
 import           System.Wlog                     (WithLogger, logInfo)
 
 import           Pos.Binary                      ()
@@ -122,13 +124,12 @@ runRealModeDo NodeResources {..} outSpecs action =
         case npEnableMetrics of
             False -> return Nothing
             True  -> Just <$> do
-                ekgStore' <- setupMonitor
-                    (runProduction . runToProd JsonLogDisabled oq) node' nrEkgStore
-                liftIO $ Metrics.registerGcMetrics ekgStore'
+                registerMetrics (Just cardanoNamespace) (runProduction . runToProd JsonLogDisabled oq) node' nrEkgStore
+                liftIO $ Metrics.registerGcMetrics nrEkgStore
                 mEkgServer <- case npEkgParams of
                     Nothing -> return Nothing
                     Just (EkgParams {..}) -> Just <$> do
-                        liftIO $ Monitoring.forkServerWith ekgStore' ekgHost ekgPort
+                        liftIO $ Monitoring.forkServerWith nrEkgStore ekgHost ekgPort
                 mStatsdServer <- case npStatsdParams of
                     Nothing -> return Nothing
                     Just (StatsdParams {..}) -> Just <$> do
@@ -140,7 +141,7 @@ runRealModeDo NodeResources {..} outSpecs action =
                                 , Monitoring.prefix = statsdPrefix
                                 , Monitoring.suffix = statsdSuffix
                                 }
-                        liftIO $ Monitoring.forkStatsd statsdOptions ekgStore'
+                        liftIO $ Monitoring.forkStatsd statsdOptions nrEkgStore
                 return (mEkgServer, mStatsdServer)
 
     stopMonitoring Nothing = return ()

node/src/Pos/Util/Monitor.hs

@@ -0,0 +1,46 @@
+{-# LANGUAGE FlexibleContexts #-}
+{-# LANGUAGE GADTs            #-}
+{-# LANGUAGE RankNTypes       #-}
+
+module Pos.Util.Monitor (
+
+      startMonitor
+    , stopMonitor
+
+    ) where
+
+import           Control.Concurrent           (killThread)
+import           Control.Monad.IO.Class       (MonadIO)
+import           Mockable.Class               (Mockable)
+import qualified Mockable.Metrics             as Metrics
+import           Node                         (Node)
+import           Node.Util.Monitor            (registerMetrics)
+import           Pos.System.Metrics.Constants (cardanoNamespace)
+import qualified System.Metrics               as Monitoring
+import qualified System.Metrics.Distribution  as Monitoring.Distribution
+import qualified System.Remote.Monitoring.Wai as Monitoring
+
+import           Universum
+
+startMonitor
+    :: ( Mockable Metrics.Metrics m
+       , Metrics.Distribution m ~ Monitoring.Distribution.Distribution
+       , MonadIO m
+       )
+    => Int
+    -> (forall t . m t -> IO t)
+    -> Node m
+    -> m Monitoring.Server
+startMonitor port lowerIO node = do
+    store <- liftIO Monitoring.newStore
+    registerMetrics (Just cardanoNamespace) lowerIO node store
+    liftIO $ Monitoring.registerGcMetrics store
+    server <- liftIO $ Monitoring.forkServerWith store "127.0.0.1" port
+    liftIO . putStrLn $ "Forked EKG server on port " ++ show port
+    return server
+
+stopMonitor
+    :: ( MonadIO m )
+    => Monitoring.Server
+    -> m ()
+stopMonitor server = liftIO $ killThread (Monitoring.serverThreadId server)