Apply suggestions from code review

Co-authored-by: Michael Peyton Jones <me@michaelpj.com>

Author: pepeiborra

cabal.project

@@ -53,7 +53,10 @@ constraints:
   ghc-lib-parser-ex -auto,
   stylish-haskell +ghc-lib
 
- source-repository-package
+-- This is benign and won't affect our ability to release to Hackage,
+-- because we only depend on `ekg-json` when a non-default flag
+-- is turned on.
+source-repository-package
   type:git
   location: https://github.com/vshabanov/ekg-json
   tag: 00ebe7211c981686e65730b7144fbf5350462608

ghcide/src/Development/IDE/Monitoring/EKG.hs

@@ -13,7 +13,7 @@ monitoring :: Logger -> Int -> IO Monitoring
 monitoring logger port = do
     store <- Monitoring.newStore
     Monitoring.registerGcMetrics store
-    let registerCounter name read = Monitoring.registerGauge name read store
+    let registerCounter name read = Monitoring.registerCounter name read store
         registerGauge name read = Monitoring.registerGauge name read store
         start = do
             server <- do

ghcide/src/Development/IDE/Types/Monitoring.hs

@@ -11,7 +11,7 @@ data Monitoring = Monitoring {
     registerGauge   :: Text -> IO Int64 -> IO (),
     -- | Register a non-negative, monotonically increasing, integer-valued metric.
     registerCounter :: Text -> IO Int64 -> IO (),
-    start :: IO (IO ())
+    start :: IO (IO ()) -- ^ Start the monitoring system, returning an action which will stop the system.
   }
 
 instance Semigroup Monitoring where