RawReporter.java

/*
 * -----------------------------------------------------------------------\
 * PerfCake
 *  
 * Copyright (C) 2010 - 2016 the original author or authors.
 *  
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 * -----------------------------------------------------------------------/
 */
package org.perfcake.reporting.reporter;

import org.perfcake.PerfCakeConst;
import org.perfcake.common.PeriodType;
import org.perfcake.reporting.MeasurementUnit;
import org.perfcake.reporting.ReportingException;
import org.perfcake.reporting.destination.Destination;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.ObjectOutputStream;
import java.util.zip.GZIPOutputStream;

/**
 * Streams all recorded {@link org.perfcake.reporting.MeasurementUnit MesurementUnits} to a file for later replay.
 *
 * @author <a href="mailto:marvenec@gmail.com">Martin Večeřa</a>
 */
public class RawReporter extends AbstractReporter {

   /**
    * The reporter's logger.
    */
   private static final Logger log = LogManager.getLogger(RawReporter.class);

   /**
    * Where to write all the objects.
    */
   private ObjectOutputStream outputStream;

   /**
    * Output file.
    */
   private String outputFile = "perfcake-measurement-" + System.getProperty(PerfCakeConst.TIMESTAMP_PROPERTY) + ".raw";

   @Override
   public void start() {
      if (getDestinations().size() > 0) {
         log.warn("No destinations are supported with RawReporter. The destinations that wre configured won't be used and no results will be sent to them.");
      }
      reset();
   }

   @Override
   public void stop() {
      if (outputStream != null) {
         try {
            outputStream.flush();
            outputStream.close();
         } catch (IOException e) {
            log.warn("Unable to close the file with results: ", e);
         }
      }
   }

   @Override
   protected void doReset() {
      stop();

      try {
         final FileOutputStream fileOutputStream = new FileOutputStream(outputFile);
         final GZIPOutputStream gzip = new GZIPOutputStream(fileOutputStream);
         outputStream = new ObjectOutputStream(gzip);
         outputStream.writeObject(runInfo);
         outputStream.flush();
      } catch (IOException e) {
         log.error("Unable to open file for writing results. No results will be written: ", e);
      }
   }

   @Override
   protected void doReport(final MeasurementUnit measurementUnit) throws ReportingException {
      try {
         measurementUnit.streamOut(outputStream);
         outputStream.flush();
      } catch (IOException e) {
         throw new ReportingException("Unable to report to raw reporter. Cannot write to the output file: ", e);
      }
   }

   @Override
   public void publishResult(final PeriodType periodType, final Destination destination) throws ReportingException {
      // nothing to do, we ignore all destinations and we warned the user
   }

   /**
    * Gets the name of the output file where the results are written.
    *
    * @return The name of the output file where the results are written.
    */
   public String getOutputFile() {
      return outputFile;
   }

   /**
    * Sets the name of the output file where to write the results.
    *
    * @param outputFile
    *       The name of the output file where to write the results.
    * @return Instance of this to support fluent API.
    */
   public RawReporter setOutputFile(final String outputFile) {
      this.outputFile = outputFile;
      return this;
   }
}