Skip to content

Commit

Permalink
Merge pull request #795 from input-output-hk/PLT-9014
Browse files Browse the repository at this point in the history 
PLT-9014 Query volume benchmarking for Marlowe Runtime
  • Loading branch information
@bwbush
bwbush committed Jan 8, 2024
2 parents b212baf + f15af0c commit d3f70cb
Show file tree
Hide file tree
Showing 12 changed files with 868 additions and 0 deletions.
1 change: 1 addition & 0 deletions cabal.project
View file
Expand Up @@ -27,6 +27,7 @@ packages:
marlowe
marlowe-actus
marlowe-apps
marlowe-benchmark
marlowe-chain-sync
marlowe-cli
marlowe-client
Expand Down
53 changes: 53 additions & 0 deletions marlowe-benchmark/LICENSE
View file
@@ -0,0 +1,53 @@
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:

You must give any other recipients of the Work or Derivative Works a copy of this License; and
You must cause any modified files to carry prominent notices stating that You changed the files; and
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
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
14 changes: 14 additions & 0 deletions marlowe-benchmark/NOTICE
View file
@@ -0,0 +1,14 @@
Copyright 2019 Input Output (Hong Kong) Ltd.

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.

110 changes: 110 additions & 0 deletions marlowe-benchmark/ReadMe.md
View file
@@ -0,0 +1,110 @@
# Benchmarks for Marlowe Runtime

The `marlowe-benchmark` tool runs a series of benchmarks against Marlowe Runtime services.


## Usage

```bash
marlowe-benchmark --help
```

```console
marlowe-benchmark : execute Marlowe Runtime benchmarks

Usage: marlowe-benchmark [--version] [--host HOST] [--port PORT] [--config FILE]

This command-line tool for executing benchmarks for Marlowe Runtime.

Available options:
-h,--help Show this help text
--version Show version
--host HOST Host for Marlowe proxy service.
--port PORT Port for Marlowe proxy service.
--config FILE Name of benchmark configuration file.
```


## Configuration

The optional JSON configuration for benchmarking specifies the number clients run in parallel during benchmarking and the quantity of data processed.

| JSON Key | Haskell Type | Description |
|-------------------------|--------------|---------------------------------------------------------------------|
| `headerSyncParallelism` | `Int` | Number of parallel clients for `HeaderSync` protocol. |
| `headerMaxContracts` | `Int` | Maximum number of contracts to be read by each `HeaderSync` client. |
| `bulkParallelism` | `Int` | Number of parallel clients for the `BulkSync` protocol. |
| `bulkPageSize` | `Word8` | Number of blocks to fetch at a time for the `BulkSync` clients. |
| `bulkMaxBlocks` | `Int` | Maximum number of blocks to fetch for each `BulkSync` client. |
| `syncParallelism` | `Int` | Number of parallel clients for `Sync` protocol. |
| `syncBatchSize` | `Int` | Number of contracts to be read by each `Sync` client. |
| `queryParallelism` | `Int` | Number of parallel clients for `Query` protocol. |
| `queryBatchSize` | `Int` | Number of queries to be executed by each `Query` client. |
| `queryPageSize` | `Int` | Page size for each `Query` client. |



## Example output

The output is lines of JSON, with one report per benchmarking client.

```bash
marlowe-benchmark
```

```console
{"blocksPerSecond":11.771785516655209,"contractsPerSecond":15.269010744861106,"metric":"HeaderSync","seconds":574.169482653}
{"blocksPerSecond":11.770062718147265,"contractsPerSecond":15.266776128125029,"metric":"HeaderSync","seconds":574.253524544}
{"blocksPerSecond":11.771827242209914,"contractsPerSecond":15.269064866467572,"metric":"HeaderSync","seconds":574.167447494}
{"blocksPerSecond":11.771792207230698,"contractsPerSecond":15.269019423108674,"metric":"HeaderSync","seconds":574.16915632}
{"applyInputsPerSecond":942.8365324905556,"blocksPerSecond":978.2612577741164,"createsPerSecond":180.32465581089704,"metric":"BulkSync","seconds":37.487940679,"withdrawsPerSecond":20.806691055103503}
{"applyInputsPerSecond":945.7512794506212,"blocksPerSecond":981.2855190633082,"createsPerSecond":180.88212332964207,"metric":"BulkSync","seconds":37.372405164,"withdrawsPerSecond":20.871014230343317}
{"applyInputsPerSecond":927.177585961421,"blocksPerSecond":962.0139654820538,"createsPerSecond":177.3297632224984,"metric":"BulkSync","seconds":38.121068213,"withdrawsPerSecond":20.461126525672892}
{"applyInputsPerSecond":949.2986468390368,"blocksPerSecond":984.9661699116706,"createsPerSecond":181.5605843155153,"metric":"BulkSync","seconds":37.23275085,"withdrawsPerSecond":20.949298190251767}
{"contractsPerSecond":1.6611365871553612,"metric":"Sync","seconds":308.222697615,"stepsPerSecond":6.787300274080108}
{"contractsPerSecond":1.6320142779350748,"metric":"Sync","seconds":313.722745519,"stepsPerSecond":6.830872260966534}
{"contractsPerSecond":1.6615895324437109,"metric":"Sync","seconds":308.138676853,"stepsPerSecond":6.759943351719238}
{"contractsPerSecond":1.6544344963387472,"metric":"Sync","seconds":309.471303417,"stepsPerSecond":6.750221997757115}
{"contractsPerSecond":3072.685366781302,"metric":"Query","pagesPerSecond":12.266908616099643,"queriesPerSecond":0.35048310331713267,"query":"No policy ID","seconds":45.651273481}
{"contractsPerSecond":3083.3628083568774,"metric":"Query","pagesPerSecond":12.309535564331096,"queriesPerSecond":0.3517010161237456,"query":"No policy ID","seconds":45.493186731}
{"contractsPerSecond":3066.656834056088,"metric":"Query","pagesPerSecond":12.242841244663293,"queriesPerSecond":0.3497954641332369,"query":"No policy ID","seconds":45.741016224}
{"contractsPerSecond":3087.258954561369,"metric":"Query","pagesPerSecond":12.325089929240097,"queriesPerSecond":0.35214542654971703,"query":"No policy ID","seconds":45.435773955}
```

Tools like `jq` and `dasel` can convert the output to CSV files.

```bash
marlowe-benchmark > results.json
for x in Sync BulkSync HeaderSync Query
do
echo
jq -s 'map(select(.metric == "'$x'"))' result.json \
| dasel -r json -w csv --csv-comma $'\t'
done
```

```console
contractsPerSecond metric seconds stepsPerSecond
1.661137 Sync 308.222698 6.787300
1.632014 Sync 313.722746 6.830872
1.661590 Sync 308.138677 6.759943
1.654434 Sync 309.471303 6.750222

applyInputsPerSecond blocksPerSecond createsPerSecond metric seconds withdrawsPerSecond
942.836532 978.261258 180.324656 BulkSync 37.487941 20.806691
945.751279 981.285519 180.882123 BulkSync 37.372405 20.871014
927.177586 962.013965 177.329763 BulkSync 38.121068 20.461127
949.298647 984.966170 181.560584 BulkSync 37.232751 20.949298

blocksPerSecond contractsPerSecond metric seconds
11.771786 15.269011 HeaderSync 574.169483
11.770063 15.266776 HeaderSync 574.253525
11.771827 15.269065 HeaderSync 574.167447
11.771792 15.269019 HeaderSync 574.169156

contractsPerSecond metric pagesPerSecond queriesPerSecond query seconds
3072.685367 Query 12.266909 0.350483 No policy ID 45.651273
3083.362808 Query 12.309536 0.351701 No policy ID 45.493187
3066.656834 Query 12.242841 0.349795 No policy ID 45.741016
3087.258955 Query 12.325090 0.352145 No policy ID 45.435774
```
88 changes: 88 additions & 0 deletions marlowe-benchmark/app/Language/Marlowe/Runtime/Benchmark.hs
View file
@@ -0,0 +1,88 @@
{-# LANGUAGE RecordWildCards #-}

-- | Benchmark for protocols.
module Language.Marlowe.Runtime.Benchmark (
-- * Benchmarking
BenchmarkConfig (..),
measure,
) where

import Control.Monad (forM_, when)
import Control.Monad.IO.Class (liftIO)
import Control.Monad.Trans.Marlowe (MarloweT)
import Data.Aeson (FromJSON, ToJSON)
import Data.Default (Default (..))
import Data.Word (Word8)
import GHC.Generics (Generic)

import qualified Data.Aeson as A (encode)
import qualified Data.ByteString.Lazy.Char8 as LBS8 (putStrLn)
import qualified Language.Marlowe.Runtime.Benchmark.BulkSync as Bulk (measure)
import qualified Language.Marlowe.Runtime.Benchmark.HeaderSync as HeaderSync (measure)
import qualified Language.Marlowe.Runtime.Benchmark.Query as Query (measure)
import qualified Language.Marlowe.Runtime.Benchmark.Sync as Sync (measure)

-- | Benchmark configuration.
data BenchmarkConfig = BenchmarkConfig
{ headerSyncParallelism :: Int
-- ^ Number of parallel clients for `HeaderSync` protocol.
, headerMaxContracts :: Int
-- ^ Maximum number of contracts to be read by each `HeaderSync` client.
, bulkParallelism :: Int
-- ^ Number of parallel clients for the `BulkSync` protocol.
, bulkPageSize :: Word8
-- ^ Number of blocks to fetch at a time for the `BulkSync` clients.
, bulkMaxBlocks :: Int
-- ^ Maximum number of blocks to fetch for each `BulkSync` client.
, syncParallelism :: Int
-- ^ Number of parallel clients for `Sync` protocol.
, syncBatchSize :: Int
-- ^ Number of contracts to be read by each `Sync` client.
, queryParallelism :: Int
-- ^ Number of parallel clients for `Query` protocol.
, queryBatchSize :: Int
-- ^ Number of queries to be executed by each `Query` client.
, queryPageSize :: Int
-- ^ Page size for each `Query` client.
}
deriving (Eq, FromJSON, Generic, Ord, Show, ToJSON)

instance Default BenchmarkConfig where
def =
BenchmarkConfig
{ headerSyncParallelism = 4
, headerMaxContracts = maxBound
, bulkParallelism = 4
, bulkPageSize = 128
, bulkMaxBlocks = maxBound
, syncParallelism = 4
, syncBatchSize = 512
, queryParallelism = 4
, queryBatchSize = 16
, queryPageSize = 256
}

-- | Run the benchmarks.
measure
:: BenchmarkConfig
-> MarloweT IO ()
measure BenchmarkConfig{..} =
do
when (headerSyncParallelism == 0) $
error "At least one `HeaderSync` client must be run."
(headerSyncResults, contractIds) <- HeaderSync.measure headerSyncParallelism headerMaxContracts
liftIO . forM_ headerSyncResults $ LBS8.putStrLn . A.encode
when (bulkParallelism > 0) $
do
bulkResults <- Bulk.measure bulkParallelism bulkPageSize bulkMaxBlocks
liftIO . forM_ bulkResults $ LBS8.putStrLn . A.encode
when (syncParallelism > 0) $
do
syncResults <- Sync.measure syncParallelism syncBatchSize contractIds
liftIO . forM_ syncResults $ LBS8.putStrLn . A.encode
when (queryParallelism > 0) $
do
queryResults <-
Query.measure queryParallelism queryBatchSize queryPageSize "No policy ID" $
replicate (queryParallelism * queryBatchSize) mempty
liftIO . forM_ queryResults $ LBS8.putStrLn . A.encode

0 comments on commit d3f70cb

Please sign in to comment.