docs update

This commit is contained in:
Jonathan Shook 2021-04-21 11:50:20 -05:00
parent 5164a4d3e1
commit 1c23d5a5ff
4 changed files with 18 additions and 8 deletions

View File

@ -107,29 +107,33 @@ Specify the graphite destination and enable reporting
--report-graphite-to <addr>[:<port>]
Specify the interval for graphite or CSV reporting in seconds (default: 10)
Specify the interval for graphite or CSV reporting in seconds:
--report-interval <interval-seconds>
--report-interval 10
Specify the metrics name prefix for graphite reporting
Specify the metrics name prefix for graphite reporting:
--metrics-prefix <metrics-prefix>
Log all HDR histogram data to a file
Log all HDR histogram data to a file:
--log-histograms histodata.log
--log-histograms 'histodata.log:.*'
--log-histograms 'histodata.log:.*:1m'
--log-histograms 'histodata.log:.*specialmetrics:10s'
Log HDR histogram stats to a CSV file
Log HDR histogram stats to a CSV file:
--log-histostats stats.csv
--log-histostats 'stats.csv:.*' # same as above
--log-histostats 'stats.csv:.*:1m' # with 1-minute interval
--log-histostats 'stats.csv:.*specialmetrics:10s'
Adjust the progress reporting interval
Adjust the HDR histogram precision:
--hdr-digits 3
Adjust the progress reporting interval:
--progress console:1m

View File

@ -17,10 +17,16 @@ public class ToHexString implements Function<ByteBuffer,String> {
private final boolean useUpperCase;
/**
* Convert the ByteBuffer's contents to a hex string using upper case by default.
*/
public ToHexString() {
this(true);
}
/**
* Convert the ByteBuffer's contents to a hex string upper or lower case.
*/
public ToHexString(boolean useUpperCase) {
this.useUpperCase = useUpperCase;
}

View File

@ -13,7 +13,7 @@ import java.util.function.LongFunction;
/**
* Converts the byte image of the input long to a MD5 digest in ByteBuffer form.
*/
@Categories(Category.conversion)
@Categories({Category.conversion,Category.premade})
@ThreadSafeMapper
public class ToMD5ByteBuffer implements LongFunction<ByteBuffer> {

View File

@ -25,7 +25,7 @@ import java.util.Iterator;
*
* <H2>Usage Patterns</H2>
*
* This is intended to be called as an interative data source, where another
* This is intended to be called as an interactive data source, where another
* iteration controls flow.
*
* <H2>Warnings</H2>