Merge branch 'stable-2.8' into stable-2.9

[ganeti-local] / src / Ganeti / DataCollectors / Types.hs

diff --git a/src/Ganeti/DataCollectors/Types.hs b/src/Ganeti/DataCollectors/Types.hs
index acd2dbc..80df40c 100644 (file)
--- a/src/Ganeti/DataCollectors/Types.hs
+++ b/src/Ganeti/DataCollectors/Types.hs
@@ -26,17 +26,66 @@ Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 -}
 
 module Ganeti.DataCollectors.Types
-  ( DCReport(..)
+  ( addStatus
+  , DCCategory(..)
+  , DCKind(..)
+  , DCReport(..)
+  , DCStatus(..)
+  , DCStatusCode(..)
   , DCVersion(..)
   , buildReport
+  , mergeStatuses
   ) where
 
+import Data.Char
 import Text.JSON
 
 import Ganeti.Constants as C
 import Ganeti.THH
 import Ganeti.Utils (getCurrentTime)
 
+-- | The possible classes a data collector can belong to.
+data DCCategory = DCInstance | DCStorage | DCDaemon | DCHypervisor
+  deriving (Show, Eq)
+
+-- | The JSON instance for DCCategory.
+instance JSON DCCategory where
+  showJSON = showJSON . map toLower . drop 2 . show
+  readJSON =
+    error "JSON read instance not implemented for type DCCategory"
+
+-- | The possible status codes of a data collector.
+data DCStatusCode = DCSCOk      -- ^ Everything is OK
+                  | DCSCTempBad -- ^ Bad, but being automatically fixed
+                  | DCSCUnknown -- ^ Unable to determine the status
+                  | DCSCBad     -- ^ Bad. External intervention required
+                  deriving (Show, Eq, Ord)
+
+-- | The JSON instance for CollectorStatus.
+instance JSON DCStatusCode where
+  showJSON DCSCOk      = showJSON (0 :: Int)
+  showJSON DCSCTempBad = showJSON (1 :: Int)
+  showJSON DCSCUnknown = showJSON (2 :: Int)
+  showJSON DCSCBad     = showJSON (4 :: Int)
+  readJSON = error "JSON read instance not implemented for type DCStatusCode"
+
+-- | The status of a \"status reporting data collector\".
+$(buildObject "DCStatus" "dcStatus"
+  [ simpleField "code"    [t| DCStatusCode |]
+  , simpleField "message" [t| String |]
+  ])
+
+-- | The type representing the kind of the collector.
+data DCKind = DCKPerf   -- ^ Performance reporting collector
+            | DCKStatus -- ^ Status reporting collector
+            deriving (Show, Eq)
+
+-- | The JSON instance for CollectorKind.
+instance JSON DCKind where
+  showJSON DCKPerf   = showJSON (0 :: Int)
+  showJSON DCKStatus = showJSON (1 :: Int)
+  readJSON = error "JSON read instance not implemented for type DCKind"
+
 -- | Type representing the version number of a data collector.
 data DCVersion = DCVerBuiltin | DCVersion String deriving (Show, Eq)
 
@@ -52,15 +101,42 @@ $(buildObject "DCReport" "dcReport"
   , simpleField "version"        [t| DCVersion |]
   , simpleField "format_version" [t| Int |]
   , simpleField "timestamp"      [t| Integer |]
+  , optionalNullSerField $
+      simpleField "category"     [t| DCCategory |]
+  , simpleField "kind"           [t| DCKind |]
   , simpleField "data"           [t| JSValue |]
   ])
 
+-- | Add the data collector status information to the JSON representation of
+-- the collector data.
+addStatus :: DCStatus -> JSValue -> JSValue
+addStatus dcStatus (JSObject obj) =
+  makeObj $ ("status", showJSON dcStatus) : fromJSObject obj
+addStatus dcStatus value = makeObj
+  [ ("status", showJSON dcStatus)
+  , ("data", value)
+  ]
+
+-- | Helper function for merging statuses.
+mergeStatuses :: (DCStatusCode, String) -> (DCStatusCode, [String])
+              -> (DCStatusCode, [String])
+mergeStatuses (newStat, newStr) (storedStat, storedStrs) =
+  let resStat = max newStat storedStat
+      resStrs =
+        if newStr == ""
+          then storedStrs
+          else storedStrs ++ [newStr]
+  in (resStat, resStrs)
+
 -- | Utility function for building a report automatically adding the current
 -- timestamp (rounded up to seconds).
 -- If the version is not specified, it will be set to the value indicating
 -- a builtin collector.
-buildReport :: String -> DCVersion -> Int -> JSValue -> IO DCReport
-buildReport name version format_version jsonData = do
+buildReport :: String -> DCVersion -> Int -> Maybe DCCategory -> DCKind
+            -> JSValue -> IO DCReport
+buildReport name version format_version category kind jsonData = do
   now <- getCurrentTime
   let timestamp = now * 1000000000 :: Integer
-  return $ DCReport name version format_version timestamp jsonData
+  return $
+    DCReport name version format_version timestamp category kind
+      jsonData