|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.HdrHistogram.HistogramLogWriter
public class HistogramLogWriter
A histogram log writer.
A Histogram logs are used to capture full fidelity, per-time-interval histograms of a recorded value.
For example, a histogram log can be used to capture high fidelity reaction-time logs for some measured system or subsystem component. Such a log would capture a full reaction time histogram for each logged interval, and could be used to later reconstruct a full HdrHistogram of the measured reaction time behavior for any arbitrary time range within the log, by adding [only] the relevant interval histograms.
This log writer will produce histogram logs that adhere to the
histogram log format (see {HistogramLogReader
for log format
details). Optional comments, start time, legend, and format version
can be logged.
By convention, it is typical for the logging application to use a comment to indicate the logging application at the head of the log, followed by the log format version, a start time, and a legend (in that order).
Constructor Summary | |
---|---|
HistogramLogWriter(File outputFile)
Constructs a new HistogramLogWriter that will write into the specified file. |
|
HistogramLogWriter(OutputStream outputStream)
Constructs a new HistogramLogWriter that will write into the specified output stream. |
|
HistogramLogWriter(PrintStream printStream)
Constructs a new HistogramLogWriter that will write into the specified print stream. |
|
HistogramLogWriter(String outputFileName)
Constructs a new HistogramLogWriter around a newly created file with the specified file name. |
Method Summary | |
---|---|
void |
outputComment(String comment)
Log a comment to the log. |
void |
outputIntervalHistogram(double startTimeStampSec,
double endTimeStampSec,
Histogram histogram)
Output an interval histogram, with the given timestamp. |
void |
outputIntervalHistogram(Histogram histogram)
Output an interval histogram, using the timestamp indicated in the histogram. |
void |
outputLegend()
Output a legend line to the log. |
void |
outputLogFormatVersion()
Output a log format version to the log. |
void |
outputStartTime(long startTimeMsec)
Log a start time in the log. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Constructor Detail |
---|
public HistogramLogWriter(String outputFileName) throws FileNotFoundException
outputFileName
- The name of the file to create
FileNotFoundException
public HistogramLogWriter(File outputFile) throws FileNotFoundException
outputFile
- The File to write to
FileNotFoundException
public HistogramLogWriter(OutputStream outputStream) throws FileNotFoundException
outputStream
- The OutputStream to write to
FileNotFoundException
public HistogramLogWriter(PrintStream printStream) throws FileNotFoundException
printStream
- The PrintStream to write to
FileNotFoundException
Method Detail |
---|
public void outputIntervalHistogram(double startTimeStampSec, double endTimeStampSec, Histogram histogram)
startTimeStampSec
- The start timestamp to log with the interval histogram, in seconds.endTimeStampSec
- The end timestamp to log with the interval histogram, in seconds.histogram
- The interval histogram to log.public void outputIntervalHistogram(Histogram histogram)
histogram
- The interval histogram to log.public void outputStartTime(long startTimeMsec)
startTimeMsec
- time (in milliseconds) since the absolute start time (the epoch)public void outputComment(String comment)
comment
- the comment string.public void outputLegend()
public void outputLogFormatVersion()
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |