bench: Integrate cardano-timeseries-io

Author: Russoul

bench/cardano-timeseries-io/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Revision history for cardano-timeseries-io
+
+## 1.0.0 -- March 2026
+
+* First version.

bench/cardano-timeseries-io/LICENSE

@@ -0,0 +1,177 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS

bench/cardano-timeseries-io/NOTICE

@@ -0,0 +1,13 @@
+Copyright 2023 Input Output Global Inc (IOG), 2023-2026 Intersect.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

bench/cardano-timeseries-io/README.md

@@ -0,0 +1,28 @@
+# Cardano Timeseries I/O
+
+## What it does
+
+The primary goal of the project is to serve as a standalone library for `cardano-tracer`, providing realtime metric storage & query.
+
+The library exposes the following components:
+- An interface of metric stores together with multiple implementations.
+- A low-level unambiguous language & its interpreter against a metric store — for querying metrics.
+- A high-level user-facing language & its elaborator to the low-level one.
+
+On top of the library the project provides a simple CLI for reading a store off disk & executing a query against it, optionally interactively.
+
+## CLI Syntax
+
+```
+Usage: cardano-timeseries-io FILE ((-x|--execute QUERY) | (-i|--interactive))
+
+  Run a query against a metric store
+
+Available options:
+  -x,--execute QUERY       Execute the query
+  -i,--interactive         Enter REPL
+  -h,--help                Show this help text
+```
+
+## Build flags
+  - _profiling_ for enabling GHC profiling support.

bench/cardano-timeseries-io/app/Cardano/Timeseries.hs

@@ -0,0 +1,29 @@
+{-# LANGUAGE OverloadedRecordDot #-}
+
+module Main where
+
+import Cardano.Timeseries.Common
+import Cardano.Timeseries.CLI
+import Data.Text (Text)
+import Options.Applicative
+import Data.Foldable
+import qualified Data.Map as Map
+import qualified Data.Text.IO as Text
+import Cardano.Timeseries.AsText (showT)
+import Cardano.Timeseries.Store
+
+main :: IO ()
+main = do
+  cmd <- execParser parseCommand
+  store <- readStore cmd.store
+  putStrLn "Metrics:"
+  for_ (Map.keys store) $ \k ->
+    Text.putStrLn ("  — " <> k <> "[" <> showMaybe (earliest store k) <> "ms; " <> showMaybe (latest store k) <> "ms]")
+  case cmd.mode of
+    Interactive -> repl store
+    Execute query -> execute store query
+  where
+   showMaybe :: Show a => Maybe a -> Text
+   showMaybe Nothing  = "N/A"
+   showMaybe (Just x) = showT x
+

bench/cardano-timeseries-io/app/Cardano/Timeseries/CLI.hs

@@ -0,0 +1,26 @@
+module Cardano.Timeseries.CLI(Mode(..), Command(..), parseCommand) where
+import           Data.Text (Text)
+import           Options.Applicative
+
+data Mode = Execute Text | Interactive
+
+data Command = Command {
+  store :: FilePath,
+  mode :: Mode
+}
+
+parseExecute :: Parser Mode
+parseExecute = Execute <$> option str (short 'x' <> long "execute" <> metavar "QUERY" <> help "Execute the query")
+
+parseInteractive :: Parser Mode
+parseInteractive = flag' Interactive (short 'i' <> long "interactive" <> help "Enter REPL")
+
+parseMode :: Parser Mode
+parseMode = parseExecute <|> parseInteractive
+
+parseStore :: Parser FilePath
+parseStore = argument str (metavar "FILE")
+
+parseCommand :: ParserInfo Command
+parseCommand = info (Command <$> parseStore <*> parseMode <**> helper)
+  (fullDesc <> progDesc "Run a query against a metric store")

bench/cardano-timeseries-io/app/Cardano/Timeseries/Common.hs

@@ -0,0 +1,102 @@
+{-# LANGUAGE FlexibleContexts #-}
+{- HLINT ignore "Use print" -}
+
+module Cardano.Timeseries.Common(readStore, repl, execute) where
+
+import           Cardano.Logging.Resources (ResourceStats, Resources (..))
+import           Cardano.Timeseries.AsText
+import           Cardano.Timeseries.Elab (elab, initialSt)
+import           Cardano.Timeseries.Import.PlainCBOR
+import           Cardano.Timeseries.Interp (interp)
+import           Cardano.Timeseries.Interp.Config (Config (..))
+import           Cardano.Timeseries.Interp.Types (QueryError)
+import           Cardano.Timeseries.Interp.Value (Value)
+import           Cardano.Timeseries.Store
+import           Cardano.Timeseries.Store.Flat (Flat)
+import           Cardano.Timeseries.Store.Flat.Parser (double)
+import qualified Cardano.Timeseries.Store.Flat.Parser as Flat.Parser
+import           Cardano.Timeseries.Store.Tree (Tree, fromFlat)
+import           Cardano.Timeseries.Surface.Expr.Parser (Parser)
+import qualified Cardano.Timeseries.Surface.Expr.Parser as Surface.Parser
+
+import           Control.DeepSeq (force)
+import           Control.Monad (forever)
+import           Control.Monad.Except (runExceptT)
+import           Control.Monad.State.Strict (evalState)
+import           Data.Foldable (traverse_)
+import           Data.Functor (void)
+import           Data.Text (Text, unpack)
+import qualified Data.Text as Text
+import qualified Data.Text.IO as Text
+import           System.Exit (die)
+import           System.FilePath (takeExtension)
+import           System.IO (hFlush, stdout)
+import           Text.Megaparsec hiding (count)
+import           Text.Megaparsec.Char (newline, space, space1)
+
+interpConfig :: Config
+interpConfig = Config {defaultRangeSamplingRateMillis = 15 * 1000}
+
+_printStore :: Flat Double -> IO ()
+_printStore = traverse_ print
+
+_printStats :: ResourceStats -> IO ()
+_printStats stats =
+  putStrLn $ "Alloc: " <> show ((fromIntegral (rAlloc stats) :: Double) / 1024 / 1024) <> "MB\n"
+          <> "Live: " <> show ((fromIntegral (rLive stats) :: Double) / 1024 / 1024) <> "MB\n"
+          <> "Heap: " <> show ((fromIntegral (rHeap stats) :: Double) / 1024 / 1024) <> "MB\n"
+          <> "RSS: " <> show ((fromIntegral (rRSS stats) :: Double) / 1024 / 1024) <> "MB"
+
+printQueryResult :: Either QueryError Value -> IO ()
+printQueryResult (Left err) = Text.putStrLn $ asText err
+printQueryResult (Right ok) = print ok
+
+repl :: Store s Double => s -> IO ()
+repl store = forever $ do
+ -- Just stats <- readResourceStats
+ -- putStrLn "----------"
+ -- printStats stats
+ putStrLn $ "Number of store entries: " <> show (count store)
+ putStrLn "----------"
+ putStr "> "
+ hFlush stdout
+ queryString <- Text.getLine
+ case parse (Surface.Parser.expr <* space <* eof) "input" queryString of
+   Left err -> putStrLn (errorBundlePretty err)
+   Right surfaceQuery -> do
+     -- putStrLn ("Surface expr: " <> show surfaceQuery)
+     case evalState (runExceptT (elab surfaceQuery)) initialSt of
+       Left err   -> Text.putStrLn err
+       Right query -> do
+         Text.putStrLn (showT query)
+         printQueryResult (evalState (runExceptT $ interp interpConfig store mempty query 0) 0)
+
+readStore :: FilePath -> IO (Tree Double)
+readStore path | takeExtension path == ".cbor" = do
+  content <- readFileSnapshots path
+  putStrLn "Read the snapshots CBOR file!"
+  let store = {-# SCC "XXX" #-} force $ fromFlat $ snapshotsToFlatStore content
+  putStrLn "Created a store from CBOR!"
+  pure store
+readStore path | takeExtension path == ".txt" = do
+  content <- Text.lines <$> Text.readFile path
+  case traverse (parse (Flat.Parser.point double <* whitespace <* eof) "input") content of
+    Left err -> die (errorBundlePretty err)
+    Right store -> pure $ fromFlat store
+readStore path = die $ "Unknown extension: " <> takeExtension path
+
+whitespace :: Parser ()
+whitespace = skipMany (try space1 <|> void newline)
+
+execute :: Store s Double => s -> Text -> IO ()
+execute store stringQuery = do
+ case parse (Surface.Parser.expr <* space <* eof) "input" stringQuery of
+   Left err -> putStrLn (errorBundlePretty err)
+   Right surfaceQuery -> do
+     putStrLn ("Expr: " <> show surfaceQuery)
+     putStrLn "-----------"
+     case evalState (runExceptT (elab surfaceQuery)) initialSt of
+       Left err   -> die (unpack err)
+       Right query -> do
+         Text.putStrLn (showT query)
+         printQueryResult (evalState (runExceptT $ interp interpConfig store mempty query 0) 0)