{"id":22812538,"url":"https://github.com/nastel/cybench-java-benchmarks","last_synced_at":"2025-04-22T16:20:34.699Z","repository":{"id":46135638,"uuid":"302020820","full_name":"Nastel/cybench-java-benchmarks","owner":"Nastel","description":"Java code benchmark focused on core java services using JMH.","archived":false,"fork":false,"pushed_at":"2023-06-14T22:52:05.000Z","size":545,"stargazers_count":5,"open_issues_count":5,"forks_count":1,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-04-22T16:19:52.313Z","etag":null,"topics":["cybench-configuration","cybench-launcher","java","java-benchmark","jmh-benchmark","jmh-benchmarks"],"latest_commit_sha":null,"homepage":"https://cybench.io","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"lgpl-2.1","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Nastel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-10-07T11:53:41.000Z","updated_at":"2022-09-26T16:41:31.000Z","dependencies_parsed_at":"2023-01-18T19:02:30.036Z","dependency_job_id":null,"html_url":"https://github.com/Nastel/cybench-java-benchmarks","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nastel%2Fcybench-java-benchmarks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nastel%2Fcybench-java-benchmarks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nastel%2Fcybench-java-benchmarks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Nastel%2Fcybench-java-benchmarks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Nastel","download_url":"https://codeload.github.com/Nastel/cybench-java-benchmarks/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250275553,"owners_count":21403680,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cybench-configuration","cybench-launcher","java","java-benchmark","jmh-benchmark","jmh-benchmarks"],"created_at":"2024-12-12T12:13:12.160Z","updated_at":"2025-04-22T16:20:34.675Z","avatar_url":"https://github.com/Nastel.png","language":"Java","readme":"# What is CyBench Benchmarks\n\n**CyBench Benchmarks** java based benchmarks that uses [CyBench Launcher](https://github.com/K2NIO/gocypher-cybench-java) to execute JMH based benchmarks. It's designed to help developers build high performance Java apps. \nSpeed-test Java classes, collections, modules, libraries and other application building blocks under varying runtime conditions. \nShare your results with the community, compare and choose the right libraries for your application. **CyBench** helps you be a better developer.\n\nDownload and run CyBench Benchmarks [here](https://github.com/K2NIO/cybench-java-benchmarks/releases).\n\nCheck out the benchmarks from other users and analyze your results here [here](https://app.cybench.io/cybench/).\n\n## Running Default Benchmarks using CyBench\n\n- Download the selected benchmark package from the [release page](https://github.com/K2NIO/cybench-java-benchmarks/releases)\n- Extract the files and run cybench.bat (on Windows) or cybench.sh (on Unix).\n- Analyze results in your console, reports folder or [app.cybench.io](https://app.cybench.io/cybench/)\n- **Otional:** manage your benchmarking run configuration located in `\u003ccybench-home\u003e/config/cybench-launcher.properties`\n\n#### CyBench launcher configuration \n\n| Property name        | Description           | Default value  |\n| ------------- |-------------| -----:|\n| **javaOptions**      | All the property fields that starts with name javaOptions will be used while benchmarking as JVM properties. | - |\n| **javaToUsePath**      | Provide full path to java.exe to be used e.g. D:/jdk180_162/bin/java.exe  | - |\n| **benchmarks**| Provide jar's with JMH benchmarks which shall be executed with CyBench. [more here](#adding-custom-benchmarks-for-execution)| - |\n| **sendReport**| Choose if the report generated will be automatically uploaded. (true/false)  | true |\n| **reportUploadStatus**| Define public or private property for the uploaded report visibility.  | public |\n| **benchAccessToken** | By providing the \"bench\" token that you get after creating a workspace in CyBench UI, you can send reports to your private directory, which will be visible only to the users that you authorize. | - |\n| **emailAddress** | Email property is used to identify report sender while sending reports to both private and public repositories | - |\n| **reportName**| Choose the uploaded report name. E.g. | - |\n| **benchmarkClasses**| Specify benchmarks by including fully qualified benchmark class names which are comma separated. For more information [more here](#execute-only-custom-benchmarks)| - |\n| **numberOfBenchmarkForks**| Number of separate full executions of a benchmark (warm up+measurement), this is returned still as one primary score item. | 1 |\n| **measurementIterations** | Number of measurements per benchmark operation, this is returned still as one primary score item. | 5 |\n| **warmUpIterations**| Number of iterations executed for warm up.  |  1 |\n| **warmUpSeconds**|  Number of seconds dedicated for each warm up iteration.  |  5  |\n| **runThreadCount**| Number of threads for benchmark test execution. |  1 |\n| **benchmarkMetadata**| A property which adds extra properties to the benchmarks report such as category or version or context. Configuration pattern is `\u003cfully qualified benchmark class name\u003e=\u003ckey1\u003e:\u003cvalue1\u003e;\u003ckey2\u003e:\u003cvalue2\u003e`. Example which adds category for class CollectionsBenchmarks: `io.cybench.launcher.CollectionsBenchmarks=category:Collections;`   |   -  |\n| **userProperties**| User defined properties which will be added to benchmarks report section `environmentSettings-\u003euserDefinedProperties` as key/value strings. Configuration pattern:`\u003ckey1\u003e:\u003cvalue1\u003e;\u003ckey2\u003e:\u003cvalue2\u003e`. Example which adds a project name:`user.propname1=My Test Project;` |  -  |\n\n\n### Adding Custom Benchmarks for Execution\n\nUpdate CyBench Launcher configuration located in `\u003ccybench-home\u003e/config/cybench-launcher.properties`:\n\n* __required__: add or update property `benchmarks`, set path to jar file which contains your JMH benchmarks, this path will be added to the `CLASSPATH` of the JVM. Values must be semicolon separated!  \n\n    Rule:\n    ```properties\n    benchmarks=\u003cpath to benchmark jar file1\u003e;\u003cpath to benchmark jar file2\u003e;\n    ```\n    \n    Example:\n    ```properties\n    benchmarks=\u003cjmh-benchmark-file\u003e.jar;\n    ```\n\n* __optional__: register categories for your tests in order to have correct tests classification and better readability and comparison in CyBench portal. Values of different classes must be semicolon separated!\n\n    Rule:\n    ```properties\n    benchmarkMetadata=\u003cfully classified benchmark class name\u003e=category:\u003ccategory name\u003e;\\\n      \u003cfully classified benchmark class name\u003e=category:\u003ccategory name\u003e;\n    ```\n       \n    Example:\n    ```properties\n    benchmarkMetadata=io.cybench.launcher.CollectionsBenchmarks=category:Collections;\n    ```\n    \n### Execute Only Custom Benchmarks\n\nUpdate CyBench configuration in order to run specific JMH tests:\n* add or update property `benchmarkClasses`, specify class names of tests which shall be executed (values must be comma separated).\n    \n    Rule:\n    ```properties\n    benchmarkClasses=\u003cfully qualified class name, or class name\u003e,\u003cfully qualified class name, or class name\u003e\n    ```\n    Example:\n    ```properties\n    benchmarkClasses=io.cybench.launcher.CollectionsBenchmarks,NumberBenchmarks\n    ```\n    \n\n## Running User-defined Benchmarks using CyBench\n\n### Add Your Benchmark to CyBench Launcher\n\nAttachment and execution of user-defined benchmarks using CyBench launcher:\n * Build a `jar` file with your benchmarks containing `jmh` compiled classes and dependecies\n * Copy benchmark `jar` file to `\u003ccybench-home\u003e` (where `gocypher-benchmarks-client.jar` resides)\n * Configure CyBench Launcher to execute your benchmarks\n\n**NOTE**:\n* User defined benchmarks must be implemented using `JMH` framework\n* Exported `jar` must contain `class` files generated by `JMH` framework (`jar` file must contain a folder `jmh_generated` with classes having `jmh` suffix ).\n* If any files are created during tests (test data files, results files) run they must be deleted after the iteration when benchmark finishes\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnastel%2Fcybench-java-benchmarks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fnastel%2Fcybench-java-benchmarks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fnastel%2Fcybench-java-benchmarks/lists"}