You are viewing a plain text version of this content. The canonical link for it is here.
Posted to common-commits@hadoop.apache.org by am...@apache.org on 2011/10/18 16:45:51 UTC
svn commit: r1185694 [6/7] - in
/hadoop/common/branches/branch-0.20-security: ./ src/contrib/
src/contrib/gridmix/src/java/org/apache/hadoop/mapred/gridmix/
src/contrib/gridmix/src/java/org/apache/hadoop/mapred/gridmix/emulators/
src/contrib/gridmix/sr...
Modified: hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/gridmix.xml
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/gridmix.xml?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/gridmix.xml (original)
+++ hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/gridmix.xml Tue Oct 18 14:45:48 2011
@@ -15,150 +15,768 @@
See the License for the specific language governing permissions and
limitations under the License.
-->
-
<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
-
<document>
-
-<header>
- <title>Gridmix</title>
-</header>
-
-<body>
-
- <section>
- <title>Overview</title>
-
- <p>Gridmix is a benchmark for live clusters. It submits a mix of synthetic
- jobs, modeling a profile mined from production loads.</p>
-
- <p>There exist three versions of the Gridmix tool. This document discusses
- the third (checked into contrib), distinct from the two checked into the
- benchmarks subdirectory. While the first two versions of the tool included
- stripped-down versions of common jobs, both were principally saturation
- tools for stressing the framework at scale. In support of a broader range of
- deployments and finer-tuned job mixes, this version of the tool will attempt
- to model the resource profiles of production jobs to identify bottlenecks,
- guide development, and serve as a replacement for the existing gridmix
- benchmarks.</p>
-
+ <header>
+ <title>GridMix</title>
+ </header>
+ <body>
+ <section id="overview">
+ <title>Overview</title>
+ <p>GridMix is a benchmark for Hadoop clusters. It submits a mix of
+ synthetic jobs, modeling a profile mined from production loads.</p>
+ <p>There exist three versions of the GridMix tool. This document
+ discusses the third (checked into <code>src/contrib</code>), distinct
+ from the two checked into the <code>src/benchmarks</code> sub-directory.
+ While the first two versions of the tool included stripped-down versions
+ of common jobs, both were principally saturation tools for stressing the
+ framework at scale. In support of a broader range of deployments and
+ finer-tuned job mixes, this version of the tool will attempt to model
+ the resource profiles of production jobs to identify bottlenecks, guide
+ development, and serve as a replacement for the existing GridMix
+ benchmarks.</p>
+ <p>To run GridMix, you need a MapReduce job trace describing the job mix
+ for a given cluster. Such traces are typically generated by Rumen (see
+ Rumen documentation). GridMix also requires input data from which the
+ synthetic jobs will be reading bytes. The input data need not be in any
+ particular format, as the synthetic jobs are currently binary readers.
+ If you are running on a new cluster, an optional step generating input
+ data may precede the run.</p>
+ <p>In order to emulate the load of production jobs from a given cluster
+ on the same or another cluster, follow these steps:</p>
+ <ol>
+ <li>Locate the job history files on the production cluster. This
+ location is specified by the
+ <code>mapred.job.tracker.history.completed.location</code>
+ configuration property of the cluster.</li>
+ <li>Run Rumen to build a job trace in JSON format for all or select
+ jobs.</li>
+ <li>Use GridMix with the job trace on the benchmark cluster.</li>
+ </ol>
+ <p>Jobs submitted by GridMix have names of the form
+ "<code>GRIDMIXnnnnnn</code>", where
+ "<code>nnnnnn</code>" is a sequence number padded with leading
+ zeroes.</p>
+ </section>
+ <section id="usage">
+ <title>Usage</title>
+ <p>Basic command-line usage without configuration parameters:</p>
+ <source>
+org.apache.hadoop.mapred.gridmix.Gridmix [-generate <size>] [-users <users-list>] <iopath> <trace>
+ </source>
+ <p>Basic command-line usage with configuration parameters:</p>
+ <source>
+org.apache.hadoop.mapred.gridmix.Gridmix \
+ -Dgridmix.client.submit.threads=10 -Dgridmix.output.directory=foo \
+ [-generate <size>] [-users <users-list>] <iopath> <trace>
+ </source>
+ <note>
+ Configuration parameters like
+ <code>-Dgridmix.client.submit.threads=10</code> and
+ <code>-Dgridmix.output.directory=foo</code> as given above should
+ be used <em>before</em> other GridMix parameters.
+ </note>
+ <p>The <code><iopath></code> parameter is the working directory for
+ GridMix. Note that this can either be on the local file-system
+ or on HDFS, but it is highly recommended that it be the same as that for
+ the original job mix so that GridMix puts the same load on the local
+ file-system and HDFS respectively.</p>
+ <p>The <code>-generate</code> option is used to generate input data and
+ Distributed Cache files for the synthetic jobs. It accepts standard units
+ of size suffixes, e.g. <code>100g</code> will generate
+ 100 * 2<sup>30</sup> bytes as input data.
+ <code><iopath>/input</code> is the destination directory for
+ generated input data and/or the directory from which input data will be
+ read. HDFS-based Distributed Cache files are generated under the
+ distributed cache directory <code><iopath>/distributedCache</code>.
+ If some of the needed Distributed Cache files are already existing in the
+ distributed cache directory, then only the remaining non-existing
+ Distributed Cache files are generated when <code>-generate</code> option
+ is specified.</p>
+ <p>The <code>-users</code> option is used to point to a users-list
+ file (see <a href="#usersqueues">Emulating Users and Queues</a>).</p>
+ <p>The <code><trace></code> parameter is a path to a job trace
+ generated by Rumen. This trace can be compressed (it must be readable
+ using one of the compression codecs supported by the cluster) or
+ uncompressed. Use "-" as the value of this parameter if you
+ want to pass an <em>uncompressed</em> trace via the standard
+ input-stream of GridMix.</p>
+ <p>The class <code>org.apache.hadoop.mapred.gridmix.Gridmix</code> can
+ be found in the JAR
+ <code>contrib/gridmix/hadoop-gridmix-$VERSION.jar</code> inside your
+ Hadoop installation, where <code>$VERSION</code> corresponds to the
+ version of Hadoop installed. A simple way of ensuring that this class
+ and all its dependencies are loaded correctly is to use the
+ <code>hadoop</code> wrapper script in Hadoop:</p>
+ <source>
+hadoop jar <gridmix-jar> org.apache.hadoop.mapred.gridmix.Gridmix \
+ [-generate <size>] [-users <users-list>] <iopath> <trace>
+ </source>
+ <p>The supported configuration parameters are explained in the
+ following sections.</p>
+ </section>
+ <section id="cfgparams">
+ <title>General Configuration Parameters</title>
+ <p/>
+ <table>
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.output.directory</code>
+ </td>
+ <td>The directory into which output will be written. If specified,
+ <code>iopath</code> will be relative to this parameter. The
+ submitting user must have read/write access to this directory. The
+ user should also be mindful of any quota issues that may arise
+ during a run. The default is "<code>gridmix</code>".</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.client.submit.threads</code>
+ </td>
+ <td>The number of threads submitting jobs to the cluster. This
+ also controls how many splits will be loaded into memory at a given
+ time, pending the submit time in the trace. Splits are pre-generated
+ to hit submission deadlines, so particularly dense traces may want
+ more submitting threads. However, storing splits in memory is
+ reasonably expensive, so you should raise this cautiously. The
+ default is 1 for the SERIAL job-submission policy (see
+ <a href="#policies">Job Submission Policies</a>) and one more than
+ the number of processors on the client machine for the other
+ policies.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.submit.multiplier</code>
+ </td>
+ <td>The multiplier to accelerate or decelerate the submission of
+ jobs. The time separating two jobs is multiplied by this factor.
+ The default value is 1.0. This is a crude mechanism to size
+ a job trace to a cluster.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.client.pending.queue.depth</code>
+ </td>
+ <td>The depth of the queue of job descriptions awaiting split
+ generation. The jobs read from the trace occupy a queue of this
+ depth before being processed by the submission threads. It is
+ unusual to configure this. The default is 5.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.gen.blocksize</code>
+ </td>
+ <td>The block-size of generated data. The default value is 256
+ MiB.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.gen.bytes.per.file</code>
+ </td>
+ <td>The maximum bytes written per file. The default value is 1
+ GiB.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.min.file.size</code>
+ </td>
+ <td>The minimum size of the input files. The default limit is 128
+ MiB. Tweak this parameter if you see an error-message like
+ "Found no satisfactory file" while testing GridMix with
+ a relatively-small input data-set.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.max.total.scan</code>
+ </td>
+ <td>The maximum size of the input files. The default limit is 100
+ TiB.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.task.jvm-options.enable</code>
+ </td>
+ <td>Enables Gridmix to configure the simulated task's max heap
+ options using the values obtained from the original task (i.e via
+ trace).
+ </td>
+ </tr>
+ </table>
+ </section>
+ <section id="jobtypes">
+ <title>Job Types</title>
+ <p>GridMix takes as input a job trace, essentially a stream of
+ JSON-encoded job descriptions. For each job description, the submission
+ client obtains the original job submission time and for each task in
+ that job, the byte and record counts read and written. Given this data,
+ it constructs a synthetic job with the same byte and record patterns as
+ recorded in the trace. It constructs jobs of two types:</p>
+ <table>
+ <tr>
+ <th>Job Type</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <code>LOADJOB</code>
+ </td>
+ <td>A synthetic job that emulates the workload mentioned in Rumen
+ trace. In the current version we are supporting I/O. It reproduces
+ the I/O workload on the benchmark cluster. It does so by embedding
+ the detailed I/O information for every map and reduce task, such as
+ the number of bytes and records read and written, into each
+ job's input splits. The map tasks further relay the I/O patterns of
+ reduce tasks through the intermediate map output data.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>SLEEPJOB</code>
+ </td>
+ <td>A synthetic job where each task does <em>nothing</em> but sleep
+ for a certain duration as observed in the production trace. The
+ scalability of the Job Tracker is often limited by how many
+ heartbeats it can handle every second. (Heartbeats are periodic
+ messages sent from Task Trackers to update their status and grab new
+ tasks from the Job Tracker.) Since a benchmark cluster is typically
+ a fraction in size of a production cluster, the heartbeat traffic
+ generated by the slave nodes is well below the level of the
+ production cluster. One possible solution is to run multiple Task
+ Trackers on each slave node. This leads to the obvious problem that
+ the I/O workload generated by the synthetic jobs would thrash the
+ slave nodes. Hence the need for such a job.</td>
+ </tr>
+ </table>
+ <p>The following configuration parameters affect the job type:</p>
+ <table>
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.job.type</code>
+ </td>
+ <td>The value for this key can be one of LOADJOB or SLEEPJOB. The
+ default value is LOADJOB.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.key.fraction</code>
+ </td>
+ <td>For a LOADJOB type of job, the fraction of a record used for
+ the data for the key. The default value is 0.1.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.sleep.maptask-only</code>
+ </td>
+ <td>For a SLEEPJOB type of job, whether to ignore the reduce
+ tasks for the job. The default is <code>false</code>.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.sleep.fake-locations</code>
+ </td>
+ <td>For a SLEEPJOB type of job, the number of fake locations
+ for map tasks for the job. The default is 0.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.sleep.max-map-time</code>
+ </td>
+ <td>For a SLEEPJOB type of job, the maximum runtime for map
+ tasks for the job in milliseconds. The default is unlimited.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.sleep.max-reduce-time</code>
+ </td>
+ <td>For a SLEEPJOB type of job, the maximum runtime for reduce
+ tasks for the job in milliseconds. The default is unlimited.</td>
+ </tr>
+ </table>
+ </section>
+ <section id="policies">
+ <title>Job Submission Policies</title>
+ <p>GridMix controls the rate of job submission. This control can be
+ based on the trace information or can be based on statistics it gathers
+ from the Job Tracker. Based on the submission policies users define,
+ GridMix uses the respective algorithm to control the job submission.
+ There are currently three types of policies:</p>
+ <table>
+ <tr>
+ <th>Job Submission Policy</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <code>STRESS</code>
+ </td>
+ <td>Keep submitting jobs so that the cluster remains under stress.
+ In this mode we control the rate of job submission by monitoring
+ the real-time load of the cluster so that we can maintain a stable
+ stress level of workload on the cluster. Based on the statistics we
+ gather we define if a cluster is <em>underloaded</em> or
+ <em>overloaded</em>. We consider a cluster <em>underloaded</em> if
+ and only if the following three conditions are true:
+ <ol>
+ <li>the number of pending and running jobs are under a threshold
+ TJ</li>
+ <li>the number of pending and running maps are under threshold
+ TM</li>
+ <li>the number of pending and running reduces are under threshold
+ TR</li>
+ </ol>
+ The thresholds TJ, TM and TR are proportional to the size of the
+ cluster and map, reduce slots capacities respectively. In case of a
+ cluster being <em>overloaded</em>, we throttle the job submission.
+ In the actual calculation we also weigh each running task with its
+ remaining work - namely, a 90% complete task is only counted as 0.1
+ in calculation. Finally, to avoid a very large job blocking other
+ jobs, we limit the number of pending/waiting tasks each job can
+ contribute.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>REPLAY</code>
+ </td>
+ <td>In this mode we replay the job traces faithfully. This mode
+ exactly follows the time-intervals given in the actual job
+ trace.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>SERIAL</code>
+ </td>
+ <td>In this mode we submit the next job only once the job submitted
+ earlier is completed.</td>
+ </tr>
+ </table>
+ <p>The following configuration parameters affect the job submission
+ policy:</p>
+ <table>
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.job-submission.policy</code>
+ </td>
+ <td>The value for this key would be one of the three: STRESS, REPLAY
+ or SERIAL. In most of the cases the value of key would be STRESS or
+ REPLAY. The default value is STRESS.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.throttle.jobs-to-tracker-ratio</code>
+ </td>
+ <td>In STRESS mode, the minimum ratio of running jobs to Task
+ Trackers in a cluster for the cluster to be considered
+ <em>overloaded</em>. This is the threshold TJ referred to earlier.
+ The default is 1.0.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.throttle.maps.task-to-slot-ratio</code>
+ </td>
+ <td>In STRESS mode, the minimum ratio of pending and running map
+ tasks (i.e. incomplete map tasks) to the number of map slots for
+ a cluster for the cluster to be considered <em>overloaded</em>.
+ This is the threshold TM referred to earlier. Running map tasks are
+ counted partially. For example, a 40% complete map task is counted
+ as 0.6 map tasks. The default is 2.0.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.throttle.reduces.task-to-slot-ratio</code>
+ </td>
+ <td>In STRESS mode, the minimum ratio of pending and running reduce
+ tasks (i.e. incomplete reduce tasks) to the number of reduce slots
+ for a cluster for the cluster to be considered <em>overloaded</em>.
+ This is the threshold TR referred to earlier. Running reduce tasks
+ are counted partially. For example, a 30% complete reduce task is
+ counted as 0.7 reduce tasks. The default is 2.5.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.throttle.maps.max-slot-share-per-job</code>
+ </td>
+ <td>In STRESS mode, the maximum share of a cluster's map-slots
+ capacity that can be counted toward a job's incomplete map tasks in
+ overload calculation. The default is 0.1.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.throttle.reducess.max-slot-share-per-job</code>
+ </td>
+ <td>In STRESS mode, the maximum share of a cluster's reduce-slots
+ capacity that can be counted toward a job's incomplete reduce tasks
+ in overload calculation. The default is 0.1.</td>
+ </tr>
+ </table>
+ </section>
+ <section id="usersqueues">
+ <title>Emulating Users and Queues</title>
+ <p>Typical production clusters are often shared with different users and
+ the cluster capacity is divided among different departments through job
+ queues. Ensuring fairness among jobs from all users, honoring queue
+ capacity allocation policies and avoiding an ill-behaving job from
+ taking over the cluster adds significant complexity in Hadoop software.
+ To be able to sufficiently test and discover bugs in these areas,
+ GridMix must emulate the contentions of jobs from different users and/or
+ submitted to different queues.</p>
+ <p>Emulating multiple queues is easy - we simply set up the benchmark
+ cluster with the same queue configuration as the production cluster and
+ we configure synthetic jobs so that they get submitted to the same queue
+ as recorded in the trace. However, not all users shown in the trace have
+ accounts on the benchmark cluster. Instead, we set up a number of testing
+ user accounts and associate each unique user in the trace to testing
+ users in a round-robin fashion.</p>
+ <p>The following configuration parameters affect the emulation of users
+ and queues:</p>
+ <table>
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.job-submission.use-queue-in-trace</code>
+ </td>
+ <td>When set to <code>true</code> it uses exactly the same set of
+ queues as those mentioned in the trace. The default value is
+ <code>false</code>.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.job-submission.default-queue</code>
+ </td>
+ <td>Specifies the default queue to which all the jobs would be
+ submitted. If this parameter is not specified, GridMix uses the
+ default queue defined for the submitting user on the cluster.</td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.user.resolve.class</code>
+ </td>
+ <td>Specifies which <code>UserResolver</code> implementation to use.
+ We currently have three implementations:
+ <ol>
+ <li><code>org.apache.hadoop.mapred.gridmix.EchoUserResolver</code>
+ - submits a job as the user who submitted the original job. All
+ the users of the production cluster identified in the job trace
+ must also have accounts on the benchmark cluster in this case.</li>
+ <li><code>org.apache.hadoop.mapred.gridmix.SubmitterUserResolver</code>
+ - submits all the jobs as current GridMix user. In this case we
+ simply map all the users in the trace to the current GridMix user
+ and submit the job.</li>
+ <li><code>org.apache.hadoop.mapred.gridmix.RoundRobinUserResolver</code>
+ - maps trace users to test users in a round-robin fashion. In
+ this case we set up a number of testing user accounts and
+ associate each unique user in the trace to testing users in a
+ round-robin fashion.</li>
+ </ol>
+ The default is
+ <code>org.apache.hadoop.mapred.gridmix.SubmitterUserResolver</code>.</td>
+ </tr>
+ </table>
+ <p>If the parameter <code>gridmix.user.resolve.class</code> is set to
+ <code>org.apache.hadoop.mapred.gridmix.RoundRobinUserResolver</code>,
+ we need to define a users-list file with a list of test users.
+ This is specified using the <code>-users</code> option to GridMix.</p>
+ <note>
+ Specifying a users-list file using the <code>-users</code> option is
+ mandatory when using the round-robin user-resolver. Other user-resolvers
+ ignore this option.
+ </note>
+ <p>A users-list file has one user per line, each line of the format:</p>
+ <source>
+ <username>
+ </source>
+ <p>For example:</p>
+ <source>
+ user1
+ user2
+ user3
+ </source>
+ <p>In the above example we have defined three users <code>user1</code>,
+ <code>user2</code> and <code>user3</code>.
+ Now we would associate each unique user in the trace to the above users
+ defined in round-robin fashion. For example, if trace's users are
+ <code>tuser1</code>, <code>tuser2</code>, <code>tuser3</code>,
+ <code>tuser4</code> and <code>tuser5</code>, then the mappings would
+ be:</p>
+ <source>
+ tuser1 -> user1
+ tuser2 -> user2
+ tuser3 -> user3
+ tuser4 -> user1
+ tuser5 -> user2
+ </source>
+ <p>For backward compatibility reasons, each line of users-list file can
+ contain username followed by groupnames in the form username[,group]*.
+ The groupnames will be ignored by Gridmix.
+ </p>
+ </section>
+
+ <section id="distributedcacheload">
+ <title>Emulating Distributed Cache Load</title>
+ <p>Gridmix emulates Distributed Cache load by default for LOADJOB type of
+ jobs. This is done by precreating the needed Distributed Cache files for all
+ the simulated jobs as part of a separate MapReduce job.</p>
+ <p>Emulation of Distributed Cache load in gridmix simulated jobs can be
+ disabled by configuring the property
+ <code>gridmix.distributed-cache-emulation.enable</code> to
+ <code>false</code>.
+ But generation of Distributed Cache data by gridmix is driven by
+ <code>-generate</code> option and is independent of this configuration
+ property.</p>
+ <p>Both generation of Distributed Cache files and emulation of
+ Distributed Cache load are disabled if:</p>
+ <ul>
+ <li>input trace comes from the standard input-stream instead of file, or</li>
+ <li><code><iopath></code> specified is on local file-system, or</li>
+ <li>any of the ascendant directories of the distributed cache directory
+ i.e. <code><iopath>/distributedCache</code> (including the distributed
+ cache directory) doesn't have execute permission for others.</li>
+ </ul>
</section>
- <section id="usage">
-
- <title>Usage</title>
-
- <p>To run Gridmix, one requires a job trace describing the job mix for a
- given cluster. Such traces are typically genenerated by Rumen (see related
- documentation). Gridmix also requires input data from which the synthetic
- jobs will draw bytes. The input data need not be in any particular format,
- as the synthetic jobs are currently binary readers. If one is running on a
- new cluster, an optional step generating input data may precede the run.</p>
-
- <p>Basic command line usage:</p>
-<source>
-
-bin/mapred org.apache.hadoop.mapred.gridmix.Gridmix [-generate <MiB>] <iopath> <trace>
-</source>
-
- <p>The <code>-generate</code> parameter accepts standard units, e.g.
- <code>100g</code> will generate 100 * 2<sup>30</sup> bytes. The
- <iopath> parameter is the destination directory for generated and/or
- the directory from which input data will be read. The <trace>
- parameter is a path to a job trace. The following configuration parameters
- are also accepted in the standard idiom, before other Gridmix
- parameters.</p>
-
- <section>
- <title>Configuration parameters</title>
- <p></p>
- <table>
- <tr><th> Parameter </th><th> Description </th><th> Notes </th></tr>
- <tr><td><code>gridmix.output.directory</code></td>
- <td>The directory into which output will be written. If specified, the
- <code>iopath</code> will be relative to this parameter.</td>
- <td>The submitting user must have read/write access to this
- directory. The user should also be mindful of any quota issues that
- may arise during a run.</td></tr>
- <tr><td><code>gridmix.client.submit.threads</code></td>
- <td>The number of threads submitting jobs to the cluster. This also
- controls how many splits will be loaded into memory at a given time,
- pending the submit time in the trace.</td>
- <td>Splits are pregenerated to hit submission deadlines, so
- particularly dense traces may want more submitting threads. However,
- storing splits in memory is reasonably expensive, so one should raise
- this cautiously.</td></tr>
- <tr><td><code>gridmix.client.pending.queue.depth</code></td>
- <td>The depth of the queue of job descriptions awaiting split
- generation.</td>
- <td>The jobs read from the trace occupy a queue of this depth before
- being processed by the submission threads. It is unusual to configure
- this.</td></tr>
- <tr><td><code>gridmix.min.key.length</code></td>
- <td>The key size for jobs submitted to the cluster.</td>
- <td>While this is clearly a job-specific, even task-specific property,
- no data on key length is currently available. Since the intermediate
- data are random, memcomparable data, not even the sort is likely
- affected. It exists as a tunable as no default value is appropriate,
- but future versions will likely replace it with trace data.</td></tr>
- </table>
-
- </section>
-</section>
-
-<section id="assumptions">
-
- <title>Simplifying Assumptions</title>
-
- <p>Gridmix will be developed in stages, incorporating feedback and patches
- from the community. Currently, its intent is to evaluate Map/Reduce and HDFS
- performance and not the layers on top of them (i.e. the extensive lib and
- subproject space). Given these two limitations, the following
- characteristics of job load are not currently captured in job traces and
- cannot be accurately reproduced in Gridmix.</p>
-
- <table>
- <tr><th>Property</th><th>Notes</th></tr>
- <tr><td>CPU usage</td><td>We have no data for per-task CPU usage, so we
- cannot attempt even an approximation. Gridmix tasks are never CPU bound
- independent of I/O, though this surely happens in practice.</td></tr>
- <tr><td>Filesystem properties</td><td>No attempt is made to match block
- sizes, namespace hierarchies, or any property of input, intermediate, or
- output data other than the bytes/records consumed and emitted from a given
- task. This implies that some of the most heavily used parts of the system-
- the compression libraries, text processing, streaming, etc.- cannot be
- meaningfully tested with the current implementation.</td></tr>
- <tr><td>I/O rates</td><td>The rate at which records are consumed/emitted is
- assumed to be limited only by the speed of the reader/writer and constant
- throughout the task.</td></tr>
- <tr><td>Memory profile</td><td>No data on tasks' memory usage over time is
- available, though the max heap size is retained.</td></tr>
- <tr><td>Skew</td><td>The records consumed and emitted to/from a given task
- are assumed to follow observed averages, i.e. records will be more regular
- than may be seen in the wild. Each map also generates a proportional
- percentage of data for each reduce, so a job with unbalanced input will be
- flattened.</td></tr>
- <tr><td>Job failure</td><td>User code is assumed to be correct.</td></tr>
- <tr><td>Job independence</td><td>The output or outcome of one job does not
- affect when or whether a subsequent job will run.</td></tr>
- </table>
-
-</section>
-
-<section>
-
- <title>Appendix</title>
-
- <p>Issues tracking the implementations of <a
- href="https://issues.apache.org/jira/browse/HADOOP-2369">gridmix1</a>, <a
- href="https://issues.apache.org/jira/browse/HADOOP-3770">gridmix2</a>, and
- <a href="https://issues.apache.org/jira/browse/MAPREDUCE-776">gridmix3</a>.
- Other issues tracking the development of Gridmix can be found by searching
- the Map/Reduce <a
- href="https://issues.apache.org/jira/browse/MAPREDUCE">JIRA</a></p>
-
-</section>
-
-</body>
-
+ <section id="simulatedjobconf">
+ <title>Configuration of Simulated Jobs</title>
+ <p> Gridmix3 sets some configuration properties in the simulated Jobs
+ submitted by it so that they can be mapped back to the corresponding Job
+ in the input Job trace. These configuration parameters include:
+ </p>
+ <table>
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.job.original-job-id</code>
+ </td>
+ <td> The job id of the original cluster's job corresponding to this
+ simulated job.
+ </td>
+ </tr>
+ <tr>
+ <td>
+ <code>gridmix.job.original-job-name</code>
+ </td>
+ <td> The job name of the original cluster's job corresponding to this
+ simulated job.
+ </td>
+ </tr>
+ </table>
+ </section>
+
+ <section id="compression-emulation">
+ <title>Emulating Compression/Decompression</title>
+ <p>MapReduce supports data compression and decompression.
+ Input to a MapReduce job can be compressed. Similarly, output of Map
+ and Reduce tasks can also be compressed. Compression/Decompression
+ emulation in GridMix is important because emulating
+ compression/decompression will effect the CPU and Memory usage of the
+ task. A task emulating compression/decompression will affect other
+ tasks and daemons running on the same node.
+ </p>
+ <p>Compression emulation is enabled if
+ <code>gridmix.compression-emulation.enable</code> is set to
+ <code>true</code>. By default compression emulation is enabled for
+ jobs of type <em>LOADJOB</em>. With compression emulation enabled,
+ GridMix will now generate compressed text data with a constant
+ compression ratio. Hence a simulated GridMix job will now emulate
+ compression/decompression using compressible text data (having a
+ constant compression ratio), irrespective of the compression ratio
+ observed in the actual job.
+ </p>
+ <p>A typical MapReduce Job deals with data compression/decompression in
+ the following phases </p>
+ <ul>
+ <li><code>Job input data decompression: </code> GridMix generates
+ compressible input data when compression emulation is enabled.
+ Based on the original job's configuration, a simulated GridMix job
+ will use a decompressor to read the compressed input data.
+ Currently, GridMix uses
+ <code>mapreduce.input.fileinputformat.inputdir</code> to determine
+ if the original job used compressed input data or
+ not. If the original job's input files are uncompressed then the
+ simulated job will read the compressed input file without using a
+ decompressor.
+ </li>
+ <li><code>Intermediate data compression and decompression: </code>
+ If the original job has map output compression enabled then GridMix
+ too will enable map output compression for the simulated job.
+ Accordingly, the reducers will use a decompressor to read the map
+ output data.
+ </li>
+ <li><code>Job output data compression: </code>
+ If the original job's output is compressed then GridMix
+ too will enable job output compression for the simulated job.
+ </li>
+ </ul>
+
+ <p>The following configuration parameters affect compression emulation
+ </p>
+ <table>
+ <tr>
+ <th>Parameter</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>gridmix.compression-emulation.enable</td>
+ <td>Enables compression emulation in simulated GridMix jobs.
+ Default is true.</td>
+ </tr>
+ </table>
+
+ <p>With compression emulation turned on, GridMix will generate compressed
+ input data. Hence the total size of the input
+ data will be lesser than the expected size. Set
+ <code>gridmix.min.file.size</code> to a smaller value (roughly 10% of
+ <code>gridmix.gen.bytes.per.file</code>) for enabling GridMix to
+ correctly emulate compression.
+ </p>
+ </section>
+
+ <section id="highram-emulation">
+ <title>Emulating High-Ram jobs</title>
+ <p>MapReduce allows users to define a job as a High-Ram job. Tasks from a
+ High-Ram job can occupy multiple slots on the task-trackers.
+ Task-tracker assigns fixed virtual memory for each slot. Tasks from
+ High-Ram jobs can occupy multiple slots and thus can use up more
+ virtual memory as compared to a default task.
+ </p>
+ <p>Emulating this behavior is important because of the following reasons
+ </p>
+ <ul>
+ <li>Impact on scheduler: Scheduling of tasks from High-Ram jobs
+ impacts the scheduling behavior as it might result into slot
+ reservation and slot/resource utilization.
+ </li>
+ <li>Impact on the node : Since High-Ram tasks occupy multiple slots,
+ trackers do some bookkeeping for allocating extra resources for
+ these tasks. Thus this becomes a precursor for memory emulation
+ where tasks with high memory requirements needs to be considered
+ as a High-Ram task.
+ </li>
+ </ul>
+ <p>High-Ram feature emulation can be disabled by setting
+ <code>gridmix.highram-emulation.enable</code> to
+ <code>false</code>.
+ </p>
+ </section>
+
+ <section id="resource-usage-emulation">
+ <title>Emulating resource usages</title>
+ <p>Usages of resources like CPU, physical memory, virtual memory, JVM heap
+ etc are recorded by MapReduce using its task counters. This information
+ is used by GridMix to emulate the resource usages in the simulated
+ tasks. Emulating resource usages will help GridMix exert similar load
+ on the test cluster as seen in the actual cluster.
+ </p>
+ <p>MapReduce tasks use up resources during its entire lifetime. GridMix
+ also tries to mimic this behavior by spanning resource usage emulation
+ across the entire lifetime of the simulated task. Each resource to be
+ emulated should have an <em>emulator</em> associated with it.
+ Each such <em>emulator</em> should implement the
+ <code>org.apache.hadoop.mapred.gridmix.emulators.resourceusage
+ .ResourceUsageEmulatorPlugin</code> interface. Resource
+ <em>emulators</em> in GridMix are <em>plugins</em> that can be
+ configured (plugged in or out) before every run. GridMix users can
+ configure multiple emulator <em>plugins</em> by passing a comma
+ separated list of <em>emulators</em> as a value for the
+ <code>gridmix.emulators.resource-usage.plugins</code> parameter.
+ </p>
+ <p>List of <em>emulators</em> shipped with GridMix:
+ </p>
+ <ul>
+ <li>Cumulative CPU usage <em>emulator</em>:
+ GridMix uses the cumulative CPU usage value published by Rumen
+ and makes sure that the total cumulative CPU usage of the simulated
+ task is close to the value published by Rumen. GridMix can be
+ configured to emulate cumulative CPU usage by adding
+ <code>org.apache.hadoop.mapred.gridmix.emulators.resourceusage
+ .CumulativeCpuUsageEmulatorPlugin</code> to the list of emulator
+ <em>plugins</em> configured for the
+ <code>gridmix.emulators.resource-usage.plugins</code> parameter.
+ CPU usage emulator is designed in such a way that
+ it only emulates at specific progress boundaries of the task. This
+ interval can be configured using
+ <code>gridmix.emulators.resource-usage.cpu.emulation-interval</code>.
+ The default value for this parameter is <code>0.1</code> i.e
+ <code>10%</code>.
+ </li>
+ <li>Total heap usage <em>emulator</em>:
+ GridMix uses the total heap usage value published by Rumen
+ and makes sure that the total heap usage of the simulated
+ task is close to the value published by Rumen. GridMix can be
+ configured to emulate total heap usage by adding
+ <code>org.apache.hadoop.mapred.gridmix.emulators.resourceusage
+ .TotalHeapUsageEmulatorPlugin</code> to the list of emulator
+ <em>plugins</em> configured for the
+ <code>gridmix.emulators.resource-usage.plugins</code> parameter.
+ Heap usage emulator is designed in such a way that
+ it only emulates at specific progress boundaries of the task. This
+ interval can be configured using
+ <code>gridmix.emulators.resource-usage.heap.emulation-interval
+ </code>. The default value for this parameter is <code>0.1</code>
+ i.e <code>10%</code> progress interval.
+</li>
+ </ul>
+ <p>Note that GridMix will emulate resource usages only for jobs of type
+ <em>LOADJOB</em>.
+ </p>
+ </section>
+
+ <section id="assumptions">
+ <title>Simplifying Assumptions</title>
+ <p>GridMix will be developed in stages, incorporating feedback and
+ patches from the community. Currently its intent is to evaluate
+ MapReduce and HDFS performance and not the layers on top of them (i.e.
+ the extensive lib and sub-project space). Given these two limitations,
+ the following characteristics of job load are not currently captured in
+ job traces and cannot be accurately reproduced in GridMix:</p>
+ <ul>
+ <li><em>Filesystem Properties</em> - No attempt is made to match block
+ sizes, namespace hierarchies, or any property of input, intermediate
+ or output data other than the bytes/records consumed and emitted from
+ a given task. This implies that some of the most heavily-used parts of
+ the system - text processing, streaming, etc. - cannot be meaningfully tested
+ with the current implementation.</li>
+ <li><em>I/O Rates</em> - The rate at which records are
+ consumed/emitted is assumed to be limited only by the speed of the
+ reader/writer and constant throughout the task.</li>
+ <li><em>Memory Profile</em> - No data on tasks' memory usage over time
+ is available, though the max heap-size is retained.</li>
+ <li><em>Skew</em> - The records consumed and emitted to/from a given
+ task are assumed to follow observed averages, i.e. records will be
+ more regular than may be seen in the wild. Each map also generates
+ a proportional percentage of data for each reduce, so a job with
+ unbalanced input will be flattened.</li>
+ <li><em>Job Failure</em> - User code is assumed to be correct.</li>
+ <li><em>Job Independence</em> - The output or outcome of one job does
+ not affect when or whether a subsequent job will run.</li>
+ </ul>
+ </section>
+ <section id="appendix">
+ <title>Appendix</title>
+ <p>Issues tracking the original implementations of <a
+ href="https://issues.apache.org/jira/browse/HADOOP-2369">GridMix1</a>,
+ <a href="https://issues.apache.org/jira/browse/HADOOP-3770">GridMix2</a>,
+ and <a
+ href="https://issues.apache.org/jira/browse/MAPREDUCE-776">GridMix3</a>
+ can be found on the Apache Hadoop MapReduce JIRA. Other issues tracking
+ the current development of GridMix can be found by searching <a
+ href="https://issues.apache.org/jira/browse/MAPREDUCE/component/12313086">the
+ Apache Hadoop MapReduce JIRA</a></p>
+ </section>
+ </body>
</document>
Added: hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/rumen.xml
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/rumen.xml?rev=1185694&view=auto
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/rumen.xml (added)
+++ hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/rumen.xml Tue Oct 18 14:45:48 2011
@@ -0,0 +1,454 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You 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.
+-->
+
+<!DOCTYPE document PUBLIC "-//APACHE//DTD Documentation V2.0//EN" "http://forrest.apache.org/dtd/document-v20.dtd">
+
+<document>
+
+<header>
+ <title>Rumen</title>
+</header>
+
+<body>
+ <!--
+ Overview [What is Rumen and why is it needed?]
+ -->
+ <section id="overview">
+ <title>Overview</title>
+
+ <p><em>Rumen</em> is a data extraction and analysis tool built for
+ <em>Apache Hadoop</em>. <em>Rumen</em> mines <em>JobHistory</em> logs to
+ extract meaningful data and stores it in an easily-parsed, condensed
+ format or <em>digest</em>. The raw trace data from MapReduce logs are
+ often insufficient for simulation, emulation, and benchmarking, as these
+ tools often attempt to measure conditions that did not occur in the
+ source data. For example, if a task ran locally in the raw trace data
+ but a simulation of the scheduler elects to run that task on a remote
+ rack, the simulator requires a runtime its input cannot provide.
+ To fill in these gaps, Rumen performs a statistical analysis of the
+ digest to estimate the variables the trace doesn't supply. Rumen traces
+ drive both Gridmix (a benchmark of Hadoop MapReduce clusters) and Mumak
+ (a simulator for the JobTracker).
+ </p>
+
+ <!--
+ Why is Rumen needed?
+ -->
+ <section>
+ <title>Motivation</title>
+
+ <ul>
+ <li>Extracting meaningful data from <em>JobHistory</em> logs is a common
+ task for any tool built to work on <em>MapReduce</em>. It
+ is tedious to write a custom tool which is so tightly coupled with
+ the <em>MapReduce</em> framework. Hence there is a need for a
+ built-in tool for performing framework level task of log parsing and
+ analysis. Such a tool would insulate external systems depending on
+ job history against the changes made to the job history format.
+ </li>
+ <li>Performing statistical analysis of various attributes of a
+ <em>MapReduce Job</em> such as <em>task runtimes, task failures
+ etc</em> is another common task that the benchmarking
+ and simulation tools might need. <em>Rumen</em> generates
+ <a href="http://en.wikipedia.org/wiki/Cumulative_distribution_function">
+ <em>Cumulative Distribution Functions (CDF)</em>
+ </a> for the Map/Reduce task runtimes.
+ Runtime CDF can be used for extrapolating the task runtime of
+ incomplete, missing and synthetic tasks. Similarly CDF is also
+ computed for the total number of successful tasks for every attempt.
+
+ </li>
+ </ul>
+ </section>
+
+ <!--
+ Basic high level view of components
+ -->
+ <section>
+ <title>Components</title>
+
+ <p><em>Rumen</em> consists of 2 components</p>
+
+ <ul>
+ <li><em>Trace Builder</em> :
+ Converts <em>JobHistory</em> logs into an easily-parsed format.
+ Currently <code>TraceBuilder</code> outputs the trace in
+ <a href="http://www.json.org/"><em>JSON</em></a>
+ format.
+ </li>
+ <li><em>Folder </em>:
+ A utility to scale the input trace. A trace obtained from
+ <em>TraceBuilder</em> simply summarizes the jobs in the
+ input folders and files. The time-span within which all the jobs in
+ a given trace finish can be considered as the trace runtime.
+ <em>Folder</em> can be used to scale the runtime of a trace.
+ Decreasing the trace runtime might involve dropping some jobs from
+ the input trace and scaling down the runtime of remaining jobs.
+ Increasing the trace runtime might involve adding some dummy jobs to
+ the resulting trace and scaling up the runtime of individual jobs.
+ </li>
+
+ </ul>
+ <p></p><p></p><p></p>
+ </section>
+ </section>
+
+ <!--
+ Usage [How to run Rumen? What are the various configuration parameters?]
+ -->
+ <section id="usage">
+ <title>How to use <em>Rumen</em>?</title>
+
+ <p>Converting <em>JobHistory</em> logs into a desired job-trace consists of
+ 2 steps</p>
+ <ol>
+ <li>Extracting information into an intermediate format</li>
+ <li>Adjusting the job-trace obtained from the intermediate trace to
+ have the desired properties.</li>
+ </ol>
+
+ <note>Extracting information from <em>JobHistory</em> logs is a one time
+ operation. This so called <em>Gold Trace</em> can be reused to
+ generate traces with desired values of properties such as
+ <code>output-duration</code>, <code>concentration</code> etc.
+ </note>
+
+ <p><em>Rumen</em> provides 2 basic commands</p>
+ <ul>
+ <li><code>TraceBuilder</code></li>
+ <li><code>Folder</code></li>
+ </ul>
+
+ <p>Firstly, we need to generate the <em>Gold Trace</em>. Hence the first
+ step is to run <code>TraceBuilder</code> on a job-history folder.
+ The output of the <code>TraceBuilder</code> is a job-trace file (and an
+ optional cluster-topology file). In case we want to scale the output, we
+ can use the <code>Folder</code> utility to fold the current trace to the
+ desired length. The remaining part of this section explains these
+ utilities in detail.
+ </p>
+
+ <note>Examples in this section assumes that certain libraries are present
+ in the java CLASSPATH. See <em>Section-3.2</em> for more details.
+ </note>
+ <!--
+ TraceBuilder command
+ -->
+ <section>
+ <title>Trace Builder</title>
+
+ <p><code>Command:</code></p>
+ <source>java org.apache.hadoop.tools.rumen.TraceBuilder [options] <jobtrace-output> <topology-output> <inputs></source>
+
+ <p>This command invokes the <code>TraceBuilder</code> utility of
+ <em>Rumen</em>. It converts the JobHistory files into a series of JSON
+ objects and writes them into the <code><jobtrace-output></code>
+ file. It also extracts the cluster layout (topology) and writes it in
+ the<code><topology-output></code> file.
+ <code><inputs></code> represents a space-separated list of
+ JobHistory files and folders.
+ </p>
+
+ <note>1) Input and output to <code>TraceBuilder</code> is expected to
+ be a fully qualified FileSystem path. So use '<em>file://</em>'
+ to specify files on the <code>local</code> FileSystem and
+ '<em>hdfs://</em>' to specify files on HDFS. Since input files or
+ folder are FileSystem paths, it means that they can be globbed.
+ This can be useful while specifying multiple file paths using
+ regular expressions.
+ </note>
+ <note>
+ 2) By default, TraceBuilder does not recursively scan the input
+ folder for job history files. Only the files that are directly
+ placed under the input folder will be considered for generating
+ the trace. To add all the files under the input directory by
+ recursively scanning the input directory, use â-recursiveâ
+ option.
+ </note>
+
+ <p>Cluster topology is used as follows :</p>
+ <ul>
+ <li>To reconstruct the splits and make sure that the
+ distances/latencies seen in the actual run are modeled correctly.
+ </li>
+ <li>To extrapolate splits information for tasks with missing splits
+ details or synthetically generated tasks.
+ </li>
+ </ul>
+
+ <p><code>Options :</code></p>
+ <table>
+ <tr>
+ <th> Parameter</th>
+ <th> Description</th>
+ <th> Notes </th>
+ </tr>
+ <tr>
+ <td><code>-demuxer</code></td>
+ <td>Used to read the jobhistory files. The default is
+ <code>DefaultInputDemuxer</code>.</td>
+ <td>Demuxer decides how the input file maps to jobhistory file(s).
+ Job history logs and job configuration files are typically small
+ files, and can be more effectively stored when embedded in some
+ container file format like SequenceFile or TFile. To support such
+ usage cases, one can specify a customized Demuxer class that can
+ extract individual job history logs and job configuration files
+ from the source files.
+ </td>
+ </tr>
+ <tr>
+ <td><code>-recursive</code></td>
+ <td>Recursively traverse input paths for job history logs.</td>
+ <td>This option should be used to inform the TraceBuilder to
+ recursively scan the input paths and process all the files under it.
+ Note that, by default, only the history logs that are directly under
+ the input folder are considered for generating the trace.
+ </td>
+ </tr>
+ </table>
+
+ <section>
+ <title>Example</title>
+ <source>java org.apache.hadoop.tools.rumen.TraceBuilder file:///home/user/job-trace.json file:///home/user/topology.output file:///home/user/logs/history/done</source>
+ <p></p>
+ <p>This will analyze all the jobs in
+ <code>/home/user/logs/history/done</code> stored on the
+ <code>local</code> FileSystem and output the jobtraces in
+ <code>/home/user/job-trace.json</code> along with topology
+ information in <code>/home/user/topology.output</code>.
+ </p>
+ </section>
+ <p></p><p></p><p></p><p></p><p></p><p></p>
+ </section>
+
+ <!--
+ Folder command
+ -->
+ <section>
+ <title>Folder</title>
+
+ <p><code>Command</code>:</p>
+ <source>java org.apache.hadoop.tools.rumen.Folder [options] [input] [output]</source>
+
+ <note>Input and output to <code>Folder</code> is expected to be a fully
+ qualified FileSystem path. So use '<em>file://</em>' to specify
+ files on the <code>local</code> FileSystem and '<em>hdfs://</em>' to
+ specify files on HDFS.
+ </note>
+
+ <p>This command invokes the <code>Folder</code> utility of
+ <em>Rumen</em>. Folding essentially means that the output duration of
+ the resulting trace is fixed and job timelines are adjusted
+ to respect the final output duration.
+ </p>
+
+ <p></p>
+ <p><code>Options :</code></p>
+ <table>
+ <tr>
+ <th> Parameter</th>
+ <th> Description</th>
+ <th> Notes </th>
+ </tr>
+ <tr>
+ <td><code>-input-cycle</code></td>
+ <td>Defines the basic unit of time for the folding operation. There is
+ no default value for <code>input-cycle</code>.
+ <strong>Input cycle must be provided</strong>.
+ </td>
+ <td>'<code>-input-cycle 10m</code>'
+ implies that the whole trace run will be now sliced at a 10min
+ interval. Basic operations will be done on the 10m chunks. Note
+ that <em>Rumen</em> understands various time units like
+ <em>m(min), h(hour), d(days) etc</em>.
+ </td>
+ </tr>
+ <tr>
+ <td><code>-output-duration</code></td>
+ <td>This parameter defines the final runtime of the trace.
+ Default value if <strong>1 hour</strong>.
+ </td>
+ <td>'<code>-output-duration 30m</code>'
+ implies that the resulting trace will have a max runtime of
+ 30mins. All the jobs in the input trace file will be folded and
+ scaled to fit this window.
+ </td>
+ </tr>
+ <tr>
+ <td><code>-concentration</code></td>
+ <td>Set the concentration of the resulting trace. Default value is
+ <strong>1</strong>.
+ </td>
+ <td>If the total runtime of the resulting trace is less than the total
+ runtime of the input trace, then the resulting trace would contain
+ lesser number of jobs as compared to the input trace. This
+ essentially means that the output is diluted. To increase the
+ density of jobs, set the concentration to a higher value.</td>
+ </tr>
+ <tr>
+ <td><code>-debug</code></td>
+ <td>Run the Folder in debug mode. By default it is set to
+ <strong>false</strong>.</td>
+ <td>In debug mode, the Folder will print additional statements for
+ debugging. Also the intermediate files generated in the scratch
+ directory will not be cleaned up.
+ </td>
+ </tr>
+ <tr>
+ <td><code>-seed</code></td>
+ <td>Initial seed to the Random Number Generator. By default, a Random
+ Number Generator is used to generate a seed and the seed value is
+ reported back to the user for future use.
+ </td>
+ <td>If an initial seed is passed, then the <code>Random Number
+ Generator</code> will generate the random numbers in the same
+ sequence i.e the sequence of random numbers remains same if the
+ same seed is used. Folder uses Random Number Generator to decide
+ whether or not to emit the job.
+ </td>
+ </tr>
+ <tr>
+ <td><code>-temp-directory</code></td>
+ <td>Temporary directory for the Folder. By default the <strong>output
+ folder's parent directory</strong> is used as the scratch space.
+ </td>
+ <td>This is the scratch space used by Folder. All the
+ temporary files are cleaned up in the end unless the Folder is run
+ in <code>debug</code> mode.</td>
+ </tr>
+ <tr>
+ <td><code>-skew-buffer-length</code></td>
+ <td>Enables <em>Folder</em> to tolerate skewed jobs.
+ The default buffer length is <strong>0</strong>.</td>
+ <td>'<code>-skew-buffer-length 100</code>'
+ indicates that if the jobs appear out of order within a window
+ size of 100, then they will be emitted in-order by the folder.
+ If a job appears out-of-order outside this window, then the Folder
+ will bail out provided <code>-allow-missorting</code> is not set.
+ <em>Folder</em> reports the maximum skew size seen in the
+ input trace for future use.
+ </td>
+ </tr>
+ <tr>
+ <td><code>-allow-missorting</code></td>
+ <td>Enables <em>Folder</em> to tolerate out-of-order jobs. By default
+ mis-sorting is not allowed.
+ </td>
+ <td>If mis-sorting is allowed, then the <em>Folder</em> will ignore
+ out-of-order jobs that cannot be deskewed using a skew buffer of
+ size specified using <code>-skew-buffer-length</code>. If
+ mis-sorting is not allowed, then the Folder will bail out if the
+ skew buffer is incapable of tolerating the skew.
+ </td>
+ </tr>
+ </table>
+
+ <section>
+ <title>Examples</title>
+ <section>
+ <title>Folding an input trace with 10 hours of total runtime to
+ generate an output trace with 1 hour of total runtime</title>
+ <source>java org.apache.hadoop.tools.rumen.Folder -output-duration 1h -input-cycle 20m file:///home/user/job-trace.json file:///home/user/job-trace-1hr.json</source>
+ <p></p>
+ <p>If the folded jobs are out of order then the command
+ will bail out.
+ </p>
+ <p>
+
+ </p>
+ </section>
+
+ <section>
+ <title>Folding an input trace with 10 hours of total runtime to
+ generate an output trace with 1 hour of total runtime and
+ tolerate some skewness
+ </title>
+ <source>java org.apache.hadoop.tools.rumen.Folder -output-duration 1h -input-cycle 20m -allow-missorting -skew-buffer-length 100 file:///home/user/job-trace.json file:///home/user/job-trace-1hr.json</source>
+ <p></p>
+ <p>If the folded jobs are out of order, then atmost
+ 100 jobs will be de-skewed. If the 101<sup>st</sup> job is
+ <em>out-of-order</em>, then the command will bail out.
+ </p>
+ </section>
+ <section>
+ <title>Folding an input trace with 10 hours of total runtime to
+ generate an output trace with 1 hour of total runtime in debug
+ mode
+ </title>
+ <source>java org.apache.hadoop.tools.rumen.Folder -output-duration 1h -input-cycle 20m -debug -temp-directory file:///tmp/debug file:///home/user/job-trace.json file:///home/user/job-trace-1hr.json</source>
+ <p></p>
+ <p>This will fold the 10hr job-trace file
+ <code>file:///home/user/job-trace.json</code> to finish within 1hr
+ and use <code>file:///tmp/debug</code> as the temporary directory.
+ The intermediate files in the temporary directory will not be cleaned
+ up.
+ </p>
+ </section>
+
+ <section>
+ <title>Folding an input trace with 10 hours of total runtime to
+ generate an output trace with 1 hour of total runtime with custom
+ concentration.
+ </title>
+ <source>java org.apache.hadoop.tools.rumen.Folder -output-duration 1h -input-cycle 20m -concentration 2 file:///home/user/job-trace.json file:///home/user/job-trace-1hr.json</source>
+ <p></p>
+ <p>This will fold the 10hr job-trace file
+ <code>file:///home/user/job-trace.json</code> to finish within 1hr
+ with concentration of 2. <code>Example-2.3.2</code> will retain 10%
+ of the jobs. With <em>concentration</em> as 2, 20% of the total input
+ jobs will be retained.
+ </p>
+ </section>
+ </section>
+ </section>
+ <p></p><p></p><p></p>
+ </section>
+
+ <!--
+ Appendix [Resources i.e ppts, jiras, definition etc]
+ -->
+ <section>
+ <title>Appendix</title>
+
+ <section>
+ <title>Resources</title>
+ <p><a href="https://issues.apache.org/jira/browse/MAPREDUCE-751">MAPREDUCE-751</a> is the main JIRA that introduced <em>Rumen</em> to <em>MapReduce</em>.
+ Look at the MapReduce <a href="https://issues.apache.org/jira/browse/MAPREDUCE/component/12313617">rumen-component</a> for further details.</p>
+ </section>
+
+ <section>
+ <title>Dependencies</title>
+ <p><em>Rumen</em> expects certain library <em>JARs</em> to be present in
+ the <em>CLASSPATH</em>.
+ The required libraries are </p>
+ <ul>
+ <li><code>Hadoop MapReduce Tools</code> (<code>hadoop-mapred-tools-{hadoop-version}.jar</code>)</li>
+ <li><code>Hadoop Common</code> (<code>hadoop-common-{hadoop-version}.jar</code>)</li>
+ <li><code>Apache Commons Logging</code> (<code>commons-logging-1.1.1.jar</code>)</li>
+ <li><code>Apache Commons CLI</code> (<code>commons-cli-1.2.jar</code>)</li>
+ <li><code>Jackson Mapper</code> (<code>jackson-mapper-asl-1.4.2.jar</code>)</li>
+ <li><code>Jackson Core</code> (<code>jackson-core-asl-1.4.2.jar</code>)</li>
+ </ul>
+
+ <note>One simple way to run Rumen is to use '$HADOOP_HOME/bin/hadoop jar'
+ option to run it.
+ </note>
+ </section>
+ </section>
+</body>
+</document>
Modified: hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/site.xml
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/site.xml?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/site.xml (original)
+++ hadoop/common/branches/branch-0.20-security/src/docs/src/documentation/content/xdocs/site.xml Tue Oct 18 14:45:48 2011
@@ -49,6 +49,7 @@ See http://forrest.apache.org/docs/linki
<vaidya label="Vaidya" href="vaidya.html"/>
<archives label="Hadoop Archives" href="hadoop_archives.html"/>
<gridmix label="Gridmix" href="gridmix.html"/>
+ <Rumen label="Rumen" href="rumen.html"/>
<cap_scheduler label="Capacity Scheduler" href="capacity_scheduler.html"/>
<fair_scheduler label="Fair Scheduler" href="fair_scheduler.html"/>
<cap_scheduler label="Hod Scheduler" href="hod_scheduler.html"/>
Modified: hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobConf.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobConf.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobConf.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobConf.java Tue Oct 18 14:45:48 2011
@@ -156,10 +156,10 @@ public class JobConf extends Configurati
*/
public static final String DEFAULT_QUEUE_NAME = "default";
- static final String MAPRED_JOB_MAP_MEMORY_MB_PROPERTY =
+ public static final String MAPRED_JOB_MAP_MEMORY_MB_PROPERTY =
"mapred.job.map.memory.mb";
- static final String MAPRED_JOB_REDUCE_MEMORY_MB_PROPERTY =
+ public static final String MAPRED_JOB_REDUCE_MEMORY_MB_PROPERTY =
"mapred.job.reduce.memory.mb";
static final String MR_ACLS_ENABLED = "mapred.acls.enabled";
Modified: hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobTracker.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobTracker.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobTracker.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/JobTracker.java Tue Oct 18 14:45:48 2011
@@ -4480,9 +4480,9 @@ public class JobTracker implements MRCon
public static final String MAPRED_CLUSTER_REDUCE_MEMORY_MB_PROPERTY =
"mapred.cluster.reduce.memory.mb";
- static final String MAPRED_CLUSTER_MAX_MAP_MEMORY_MB_PROPERTY =
+ public static final String MAPRED_CLUSTER_MAX_MAP_MEMORY_MB_PROPERTY =
"mapred.cluster.max.map.memory.mb";
- static final String MAPRED_CLUSTER_MAX_REDUCE_MEMORY_MB_PROPERTY =
+ public static final String MAPRED_CLUSTER_MAX_REDUCE_MEMORY_MB_PROPERTY =
"mapred.cluster.max.reduce.memory.mb";
/*
Modified: hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Reporter.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Reporter.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Reporter.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Reporter.java Tue Oct 18 14:45:48 2011
@@ -61,6 +61,10 @@ public interface Reporter extends Progre
public InputSplit getInputSplit() throws UnsupportedOperationException {
throw new UnsupportedOperationException("NULL reporter has no input");
}
+ @Override
+ public float getProgress() {
+ return 0;
+ }
};
/**
@@ -117,4 +121,10 @@ public interface Reporter extends Progre
*/
public abstract InputSplit getInputSplit()
throws UnsupportedOperationException;
+
+ /**
+ * Get the progress of the task. Progress is represented as a number between
+ * 0 and 1 (inclusive).
+ */
+ public float getProgress();
}
Modified: hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Task.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Task.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Task.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapred/Task.java Tue Oct 18 14:45:48 2011
@@ -586,6 +586,11 @@ abstract public class Task implements Wr
// indicate that progress update needs to be sent
setProgressFlag();
}
+
+ public float getProgress() {
+ return taskProgress.getProgress();
+ };
+
public void progress() {
// indicate that progress update needs to be sent
setProgressFlag();
Modified: hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/StatusReporter.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/StatusReporter.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/StatusReporter.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/StatusReporter.java Tue Oct 18 14:45:48 2011
@@ -21,5 +21,11 @@ public abstract class StatusReporter {
public abstract Counter getCounter(Enum<?> name);
public abstract Counter getCounter(String group, String name);
public abstract void progress();
+ /**
+ * Get the current progress.
+ * @return a number between 0.0 and 1.0 (inclusive) indicating the attempt's
+ * progress.
+ */
+ public abstract float getProgress();
public abstract void setStatus(String status);
}
Modified: hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/TaskInputOutputContext.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/TaskInputOutputContext.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/TaskInputOutputContext.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/TaskInputOutputContext.java Tue Oct 18 14:45:48 2011
@@ -93,6 +93,10 @@ public abstract class TaskInputOutputCon
reporter.progress();
}
+ public float getProgress() {
+ return reporter.getProgress();
+ }
+
@Override
public void setStatus(String status) {
reporter.setStatus(status);
Modified: hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/lib/map/MultithreadedMapper.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/lib/map/MultithreadedMapper.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/lib/map/MultithreadedMapper.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/mapred/org/apache/hadoop/mapreduce/lib/map/MultithreadedMapper.java Tue Oct 18 14:45:48 2011
@@ -235,6 +235,10 @@ public class MultithreadedMapper<K1, V1,
outer.setStatus(status);
}
+ @Override
+ public float getProgress() {
+ return outer.getProgress();
+ }
}
private class MapRunner extends Thread {
Modified: hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapred/UtilsForTests.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapred/UtilsForTests.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapred/UtilsForTests.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapred/UtilsForTests.java Tue Oct 18 14:45:48 2011
@@ -608,6 +608,16 @@ public class UtilsForTests {
public static RunningJob runJob(JobConf conf, Path inDir, Path outDir,
int numMaps, int numReds) throws IOException {
+ String input = "The quick brown fox\n" + "has many silly\n"
+ + "red fox sox\n";
+
+ // submit the job and wait for it to complete
+ return runJob(conf, inDir, outDir, numMaps, numReds, input);
+ }
+
+ // Start a job with the specified input and return its RunningJob object
+ static RunningJob runJob(JobConf conf, Path inDir, Path outDir, int numMaps,
+ int numReds, String input) throws IOException {
FileSystem fs = FileSystem.get(conf);
if (fs.exists(outDir)) {
fs.delete(outDir, true);
@@ -615,8 +625,7 @@ public class UtilsForTests {
if (!fs.exists(inDir)) {
fs.mkdirs(inDir);
}
- String input = "The quick brown fox\n" + "has many silly\n"
- + "red fox sox\n";
+
for (int i = 0; i < numMaps; ++i) {
DataOutputStream file = fs.create(new Path(inDir, "part-" + i));
file.writeBytes(input);
Modified: hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapreduce/MapReduceTestUtil.java
URL: http://svn.apache.org/viewvc/hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapreduce/MapReduceTestUtil.java?rev=1185694&r1=1185693&r2=1185694&view=diff
==============================================================================
--- hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapreduce/MapReduceTestUtil.java (original)
+++ hadoop/common/branches/branch-0.20-security/src/test/org/apache/hadoop/mapreduce/MapReduceTestUtil.java Tue Oct 18 14:45:48 2011
@@ -285,6 +285,10 @@ public class MapReduceTestUtil {
}
public void progress() {
}
+ @Override
+ public float getProgress() {
+ return 0;
+ }
public Counter getCounter(Enum<?> name) {
return new Counters().findCounter(name);
}