Browse files

Initial commit of YCSB.

Creation of git repository and inital commit of YCSB.
  • Loading branch information...
brianfrankcooper committed Apr 19, 2010
0 parents commit 24efaff35cb20b4ae730b3f23716ed73fea783d9
Showing with 24,172 additions and 0 deletions.
  1. +163 −0 LICENSE.txt
  2. +9 −0 NOTICE.txt
  3. +38 −0 README
  4. +51 −0 build.xml
  5. +30 −0 doc/coreproperties.html
  6. +59 −0 doc/coreworkloads.html
  7. +98 −0 doc/dblayer.html
  8. BIN doc/images/ycsblogo-small.png
  9. +348 −0 doc/index.html
  10. +86 −0 doc/javadoc/allclasses-frame.html
  11. +86 −0 doc/javadoc/allclasses-noframe.html
  12. +508 −0 doc/javadoc/com/yahoo/ycsb/BasicDB.html
  13. +379 −0 doc/javadoc/com/yahoo/ycsb/Client.html
  14. +270 −0 doc/javadoc/com/yahoo/ycsb/CounterGenerator.html
  15. +467 −0 doc/javadoc/com/yahoo/ycsb/DB.html
  16. +279 −0 doc/javadoc/com/yahoo/ycsb/DBException.html
  17. +252 −0 doc/javadoc/com/yahoo/ycsb/DBFactory.html
  18. +488 −0 doc/javadoc/com/yahoo/ycsb/DBWrapper.html
  19. +325 −0 doc/javadoc/com/yahoo/ycsb/DiscreteGenerator.html
  20. +360 −0 doc/javadoc/com/yahoo/ycsb/FindGoodAB.html
  21. +306 −0 doc/javadoc/com/yahoo/ycsb/FindGoodScrambleVector.html
  22. +279 −0 doc/javadoc/com/yahoo/ycsb/Generator.html
  23. +355 −0 doc/javadoc/com/yahoo/ycsb/IntegerGenerator.html
  24. +354 −0 doc/javadoc/com/yahoo/ycsb/Measurements.html
  25. +328 −0 doc/javadoc/com/yahoo/ycsb/OneMeasurement.html
  26. +390 −0 doc/javadoc/com/yahoo/ycsb/OneMeasurementHistogram.html
  27. +384 −0 doc/javadoc/com/yahoo/ycsb/OneMeasurementTimeSeries.html
  28. +391 −0 doc/javadoc/com/yahoo/ycsb/ScrambledZipfianGenerator.html
  29. +282 −0 doc/javadoc/com/yahoo/ycsb/SkewedLatestGenerator.html
  30. +360 −0 doc/javadoc/com/yahoo/ycsb/TestCollisions.html
  31. +247 −0 doc/javadoc/com/yahoo/ycsb/TestExpandedZipfian.html
  32. +247 −0 doc/javadoc/com/yahoo/ycsb/TestZipfian.html
  33. +285 −0 doc/javadoc/com/yahoo/ycsb/UniformGenerator.html
  34. +270 −0 doc/javadoc/com/yahoo/ycsb/UniformIntegerGenerator.html
  35. +279 −0 doc/javadoc/com/yahoo/ycsb/UnknownDBException.html
  36. +419 −0 doc/javadoc/com/yahoo/ycsb/Utils.html
  37. +440 −0 doc/javadoc/com/yahoo/ycsb/Workload.html
  38. +279 −0 doc/javadoc/com/yahoo/ycsb/WorkloadException.html
  39. +495 −0 doc/javadoc/com/yahoo/ycsb/ZipfianGenerator.html
  40. +630 −0 doc/javadoc/com/yahoo/ycsb/db/CassandraClient.html
  41. +666 −0 doc/javadoc/com/yahoo/ycsb/db/HBaseClient.html
  42. +757 −0 doc/javadoc/com/yahoo/ycsb/db/ShardClient.html
  43. +1,280 −0 doc/javadoc/com/yahoo/ycsb/db/SherpaClient.html
  44. +34 −0 doc/javadoc/com/yahoo/ycsb/db/package-frame.html
  45. +156 −0 doc/javadoc/com/yahoo/ycsb/db/package-summary.html
  46. +149 −0 doc/javadoc/com/yahoo/ycsb/db/package-tree.html
  47. +95 −0 doc/javadoc/com/yahoo/ycsb/package-frame.html
  48. +270 −0 doc/javadoc/com/yahoo/ycsb/package-summary.html
  49. +160 −0 doc/javadoc/com/yahoo/ycsb/package-tree.html
  50. +969 −0 doc/javadoc/com/yahoo/ycsb/workloads/CoreWorkload.html
  51. +32 −0 doc/javadoc/com/yahoo/ycsb/workloads/package-frame.html
  52. +152 −0 doc/javadoc/com/yahoo/ycsb/workloads/package-summary.html
  53. +149 −0 doc/javadoc/com/yahoo/ycsb/workloads/package-tree.html
  54. +534 −0 doc/javadoc/constant-values.html
  55. +140 −0 doc/javadoc/deprecated-list.html
  56. +213 −0 doc/javadoc/help-doc.html
  57. +827 −0 doc/javadoc/index-all.html
  58. +39 −0 doc/javadoc/index.html
  59. +44 −0 doc/javadoc/overview-frame.html
  60. +150 −0 doc/javadoc/overview-summary.html
  61. +161 −0 doc/javadoc/overview-tree.html
  62. +2 −0 doc/javadoc/package-list
  63. BIN doc/javadoc/resources/inherit.gif
  64. +188 −0 doc/javadoc/serialized-form.html
  65. +29 −0 doc/javadoc/stylesheet.css
  66. +46 −0 doc/parallelclients.html
  67. +31 −0 doc/tipsfaq.html
  68. +129 −0 doc/workload.html
  69. +270 −0 src/com/yahoo/ycsb/
  70. +716 −0 src/com/yahoo/ycsb/
  71. +49 −0 src/com/yahoo/ycsb/
  72. +125 −0 src/com/yahoo/ycsb/
  73. +47 −0 src/com/yahoo/ycsb/
  74. +65 −0 src/com/yahoo/ycsb/
  75. +166 −0 src/com/yahoo/ycsb/
  76. +110 −0 src/com/yahoo/ycsb/
  77. +131 −0 src/com/yahoo/ycsb/
  78. +146 −0 src/com/yahoo/ycsb/
  79. +37 −0 src/com/yahoo/ycsb/
  80. +70 −0 src/com/yahoo/ycsb/
  81. +144 −0 src/com/yahoo/ycsb/
  82. +44 −0 src/com/yahoo/ycsb/
  83. +164 −0 src/com/yahoo/ycsb/
  84. +172 −0 src/com/yahoo/ycsb/
  85. +117 −0 src/com/yahoo/ycsb/
  86. +53 −0 src/com/yahoo/ycsb/
  87. +142 −0 src/com/yahoo/ycsb/
  88. +63 −0 src/com/yahoo/ycsb/
  89. +79 −0 src/com/yahoo/ycsb/
  90. +67 −0 src/com/yahoo/ycsb/
  91. +50 −0 src/com/yahoo/ycsb/
  92. +47 −0 src/com/yahoo/ycsb/
  93. +116 −0 src/com/yahoo/ycsb/
  94. +93 −0 src/com/yahoo/ycsb/
  95. +47 −0 src/com/yahoo/ycsb/
  96. +317 −0 src/com/yahoo/ycsb/
  97. +496 −0 src/com/yahoo/ycsb/db/
  98. +518 −0 src/com/yahoo/ycsb/db/
  99. +41 −0 src/com/yahoo/ycsb/db/conf/hbase-site.xml
  100. +517 −0 src/com/yahoo/ycsb/workloads/
  101. +37 −0 workloads/workloada
  102. +36 −0 workloads/workloadb
  103. +38 −0 workloads/workloadc
  104. +41 −0 workloads/workloadd
  105. +46 −0 workloads/workloade
  106. +37 −0 workloads/workloadf
@@ -0,0 +1,163 @@
+Apache License
+Version 2.0, January 2004
+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
+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 nr work.
+To apply the Apache License to your work, attach the following
+boilerplate notice, with the fields enclosed by brackets "[]" replaced
+with your own identifying information. (Don't include the brackets!)
+The text should be enclosed in the appropriate comment syntax for the
+file format. We also recommend that a file or class name and
+description of purpose be included on the same "printed page" as the
+copyright notice for easier identification within third-party
+Copyright [yyyy] [name of copyright owner]
+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
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+See the License for the specific language governing permissions and
+limitations under the License.
@@ -0,0 +1,9 @@
+NOTICE file for use with, and corresponding to Section 4 of,
+the Apache License, Version 2.0,
+in this case for the YCSB project.
+ This product includes software developed by
+ Yahoo! Inc. (
+ Copyright (c) 2010 Yahoo! Inc. All rights reserved.
@@ -0,0 +1,38 @@
+Yahoo! Cloud System Benchmark (YCSB)
+It is difficult to decide which system is right for your application,
+partially because the features differ between systems, and partially
+because there is not an easy way to compare the performance of one
+system versus another.
+The goal of the YCSB project is to develop a framework and common set
+of workloads for evaluating the performance of different "key-value"
+and "cloud" serving stores. The project comprises two things:
+* The YCSB Client, an extensible workload generator
+* The Core workloads, a set of workload scenarios to be executed by
+ the generator
+Although the core workloads provide a well rounded picture of a
+system's performance, the Client is extensible so that you can define
+new and different workloads to examine system aspects, or application
+scenarios, not adequately covered by the core workload. Similarly, the
+Client is extensible to support benchmarking different
+databases. Although we include sample code for benchmarking HBase and
+Cassandra, it is straightforward to write a new interface layer to
+benchmark your favorite database.
+A common use of the tool is to benchmark multiple systems and compare
+them. For example, you can install multiple systems on the same
+hardward configuration, and run the same workloads against each
+system. Then you can plot the performance of each system (for example,
+as latency versus throughput curves) to see when one system does
+better than another.
+Detailed information about using the benchmark is available in the
+doc/index.html file.
@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="UTF-8"?>
+ <project name="ycsb" default="compile" basedir=".">
+ <property name="src.dir" value="src"/>
+ <property name="doc.dir" value="doc"/>
+ <property name="dbsrc.dir" value="${src.dir}/com/yahoo/ycsb/db"/>
+ <property name="dblib.dir" value="${dbsrc.dir}/lib"/>
+ <property name="build.dir" value="build"/>
+ <property name="classes.dir" value="${build.dir}/classes"/>
+ <property name="jar.dir" value="${build.dir}/jar"/>
+ <path id="classpath">
+ <fileset dir="${dblib.dir}" includes="**/*.jar"/>
+ </path>
+ <target name="compile">
+ <mkdir dir="${classes.dir}"/>
+ <javac srcdir="${src.dir}" destdir="${classes.dir}" excludes="com/yahoo/ycsb/db/**" deprecation="on">
+ <compilerarg value="-Xlint:unchecked"/>
+ </javac>
+ <antcall target="makejar"/>
+ </target>
+ <target name="dbcompile">
+ <mkdir dir="${classes.dir}"/>
+ <javac srcdir="${dbsrc.dir}" destdir="${classes.dir}" classpathref="classpath" deprecation="on">
+ <compilerarg value="-Xlint:unchecked"/>
+ </javac>
+ <antcall target="makejar"/>
+ </target>
+ <target name ="makejar" description="Create a jar for the YCSB project">
+ <jar jarfile="build/ycsb.jar" includes="**/*.class" basedir="${classes.dir}"/>
+ </target>
+ <target name="clean">
+ <delete includeemptydirs="true">
+ <fileset dir="build" includes="**/*"/>
+ </delete>
+ </target>
+ <target name="doc">
+ <javadoc sourcepath="${src.dir}" destdir="${doc.dir}/javadoc" packagenames=","/>
+ </target>
@@ -0,0 +1,30 @@
+<TITLE>YCSB - Core workload package properties</TITLE>
+<H1><img src="images/ycsblogo-small.png"> Yahoo! Cloud Serving Benchmark</H1>
+<H3>Version 0.1</H3>
+<A HREF="index.html">Home</A> - <A href="coreworkloads.html">Core workloads</A> - <a href="tipsfaq.html">Tips and FAQ</A>
+<H2>Core workload package properties</h2>
+The property files used with the core workload generator can specify values for the following properties:<p>
+<LI><b>fieldcount</b>: the number of fields in a record (default: 10)
+<LI><b>fieldlength</b>: the size of each field (default: 100)
+<LI><b>readallfields</b>: should reads read all fields (true) or just one (false) (default: true)
+<LI><b>readproportion</b>: what proportion of operations should be reads (default: 0.95)
+<LI><b>updateproportion</b>: what proportion of operations should be updates (default: 0.05)
+<LI><b>insertproportion</b>: what proportion of operations should be inserts (default: 0)
+<LI><b>scanproportion</b>: what proportion of operations should be scans (default: 0)
+<LI><b>readmodifywriteproportion</b>: what proportion of operations should be read a record, modify it, write it back (default: 0)
+<LI><b>requestdistribution</b>: what distribution should be used to select the records to operate on - uniform, zipfian or latest (default: uniform)
+<LI><b>maxscanlength</b>: for scans, what is the maximum number of records to scan (default: 1000)
+<LI><b>scanlengthdistribution</b>: for scans, what distribution should be used to choose the number of records to scan, for each scan, between 1 and maxscanlength (default: uniform)
+<LI><b>insertorder</b>: should records be inserted in order by key ("ordered"), or in hashed order ("hashed") (default: hashed)
+YCSB - Yahoo! Research - Contact
@@ -0,0 +1,59 @@
+<TITLE>YCSB - Core workloads</TITLE>
+<H1><img src="images/ycsblogo-small.png"> Yahoo! Cloud Serving Benchmark</H1>
+<H3>Version 0.1</H3>
+<A HREF="index.html">Home</A> - <A href="coreworkloads.html">Core workloads</A> - <a href="tipsfaq.html">Tips and FAQ</A>
+<H2>Core workloads</h2>
+YCSB includes a set of core workloads that define a basic benchmark for cloud systems. Of course, you can define your own workloads, as described <a href="workload.html">here</A>. However,
+the core workloads are a useful first step, and obtaining these benchmark numbers for a variety of different systems would allow you to understand the performance
+tradeoffs of different systems.
+The core workloads consist of six different workloads:
+<B>Workload A: Update heavy workload</B>
+This workload has a mix of 50/50 reads and writes. An application example is a session store recording recent actions.
+<B>Workload B: Read mostly workload</B>
+This workload has a 95/5 reads/write mix. Application example: photo tagging; add a tag is an update, but most operations are to read tags.
+<B>Workload C: Read only</B>
+This workload is 100% read. Application example: user profile cache, where profiles are constructed elsewhere (e.g., Hadoop).
+<B>Workload D: Read latest workload</B>
+In this workload, new records are inserted, and the most recently inserted records are the most popular. Application example: user status updates; people want to read the latest.
+<B>Workload E: Short ranges</B>
+In this workload, short ranges of records are queried, instead of individual records. Application example: threaded conversations, where each scan is for the posts in a given thread (assumed to be clustered by thread id).
+<B>Workload F: Read-modify-write</B>
+In this workload, the client will read a record, modify it, and write back the changes. Application example: user database, where user records are read and modified by the user or to record user activity.
+<H2>Running the workloads</H2>
+All six workloads have a data set which is similar. Workloads D and E insert records during the test run. Thus, to keep the database size consistent, we recommend the following sequence:
+<LI>Load the database, using workload A's parameter file (workloads/workloada) and the "-load" switch to the client.
+<LI>Run workload A (using workloads/workloada and "-t") for a variety of throughputs.
+<LI>Run workload B (using workloads/workloadb and "-t") for a variety of throughputs.
+<LI>Run workload C (using workloads/workloadc and "-t") for a variety of throughputs.
+<LI>Run workload F (using workloads/workloadf and "-t") for a variety of throughputs.
+<LI>Run workload D (using workloads/workloadd and "-t") for a variety of throughputs. This workload inserts records, increasing the size of the database.
+<LI>Delete the data in the database.
+<LI>Reload the database, using workload E's parameter file (workloads/workloade) and the "-load switch to the client.
+<LI>Run workload E (using workloads/workloadd and "-t") for a variety of throughputs. This workload inserts records, increasing the size of the database.
+YCSB - Yahoo! Research - Contact
Oops, something went wrong.

0 comments on commit 24efaff

Please sign in to comment.