TestUserDefinedCounters.java

/**
 * 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.
 */
package org.apache.hadoop.mapred;

import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
import java.io.InputStreamReader;
import java.io.OutputStream;
import java.io.OutputStreamWriter;
import java.io.Writer;
import java.util.Iterator;
import java.util.Properties;

import org.apache.hadoop.fs.FileUtil;
import org.apache.hadoop.fs.Path;
import org.apache.hadoop.io.LongWritable;
import org.apache.hadoop.io.Text;
import org.apache.hadoop.mapred.Counters.Counter;
import org.apache.hadoop.mapred.lib.IdentityMapper;
import org.apache.hadoop.mapred.lib.IdentityReducer;
import org.apache.hadoop.util.StringUtils;
import org.hsqldb.lib.StringUtil;

public class TestUserDefinedCounters extends ClusterMapReduceTestCase {
  protected void setUp() throws Exception {
    super.setUp();
    Properties prop = new Properties();
    prop.put("mapred.job.tracker.persist.jobstatus.active", "true");
    prop.put("mapred.job.tracker.persist.jobstatus.hours", "1");
    startCluster(true, prop);
  }
  
  enum EnumCounter { MAP_RECORDS }
  
  static class CountingMapper<K, V> extends IdentityMapper<K, V> {
    private JobConf jconf;
    boolean generateUniqueCounters = false;
    
    @Override
    public void configure(JobConf jconf) {
      this.jconf = jconf;
      this.generateUniqueCounters = 
        jconf.getBoolean("task.generate.unique.counters", false);
    }
    
    public void map(K key, V value,
        OutputCollector<K, V> output, Reporter reporter)
        throws IOException {
      output.collect(key, value);
      reporter.incrCounter(EnumCounter.MAP_RECORDS, 1);
      reporter.incrCounter("StringCounter", "MapRecords", 1);
      for (int i =0; i < 50; i++) {
        if (generateUniqueCounters) {
          reporter.incrCounter("StringCounter", "countername_" + 
              jconf.get("mapred.task.id") + "_"+ i, 1);
        } else {
          reporter.incrCounter("StringCounter", "countername_" + 
              i, 1);
        }
      }    
    }
  }
  
  public void testMapReduceJob() throws Exception {
    OutputStream os = getFileSystem().create(new Path(getInputDir(), "text.txt"));
    Writer wr = new OutputStreamWriter(os);
    wr.write("hello1\n");
    wr.write("hello2\n");
    wr.write("hello3\n");
    wr.write("hello4\n");
    wr.close();

    JobConf conf = createJobConf();
    conf.setJobName("counters");
    
    conf.setInputFormat(TextInputFormat.class);

    conf.setMapOutputKeyClass(LongWritable.class);
    conf.setMapOutputValueClass(Text.class);

    conf.setOutputFormat(TextOutputFormat.class);
    conf.setOutputKeyClass(LongWritable.class);
    conf.setOutputValueClass(Text.class);

    conf.setMapperClass(CountingMapper.class);
    conf.setReducerClass(IdentityReducer.class);

    FileInputFormat.setInputPaths(conf, getInputDir());

    FileOutputFormat.setOutputPath(conf, getOutputDir());

    RunningJob runningJob = JobClient.runJob(conf);

    Path[] outputFiles = FileUtil.stat2Paths(
                           getFileSystem().listStatus(getOutputDir(),
                           new Utils.OutputFileUtils.OutputFilesFilter()));
    if (outputFiles.length > 0) {
      InputStream is = getFileSystem().open(outputFiles[0]);
      BufferedReader reader = new BufferedReader(new InputStreamReader(is));
      String line = reader.readLine();
      int counter = 0;
      while (line != null) {
        counter++;
        assertTrue(line.contains("hello"));
        line = reader.readLine();
      }
      reader.close();
      assertEquals(4, counter);
    }

    assertEquals(4,
        runningJob.getCounters().getCounter(EnumCounter.MAP_RECORDS));
    Counters counters = runningJob.getCounters();
    assertEquals(4,
        runningJob.getCounters().getGroup("StringCounter")
        .getCounter("MapRecords"));
    assertTrue(counters.getGroupNames().size() <= Counters.MAX_GROUP_LIMIT);
    int i = 0;
    while (counters.size() < Counters.MAX_COUNTER_LIMIT) {
      counters.incrCounter("IncrCounter", "limit " + i, 2);
      i++;
    }
    try {
      counters.incrCounter("IncrCountertest", "test", 2);
      assertTrue(false);
    } catch(RuntimeException re) {
      System.out.println("Exceeded counter " + 
          StringUtils.stringifyException(re));
    }
    conf.setBoolean("task.generate.unique.counters", true);
    FileOutputFormat.setOutputPath(conf, new Path("output-fail"));
    try {
      runningJob = JobClient.runJob(conf);
    } catch(Exception ie) {
      System.out.println(StringUtils.stringifyException(ie));
    }
  }
}