public static class HistogramDescriptor.HistogramDescriptorBuilder extends MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
HistogramDescriptor
be specified during its own construction. Values may also be specified
for the optional arguments needed for a HistogramDescriptor
, but
these values are defaulted in the event that no value is specified for
them.appId, description, jmx, name, persist, primaryTag, secondaryTag, summaryMinutes, type
Constructor and Description |
---|
HistogramDescriptorBuilder(String name)
Creates a new
HistogramDescriptor.HistogramDescriptorBuilder using only the
arguments that are required to build a valid HistogramDescriptor . |
public HistogramDescriptorBuilder(String name)
HistogramDescriptor.HistogramDescriptorBuilder
using only the
arguments that are required to build a valid HistogramDescriptor
. If no other fields are set via other methods
before building, the resulting HistogramDescriptor
will
specify a TimeStampedHistogram
associated with no specific
application, no primary or secondary tags, no description, and that
the resulting TimeStampedHistogram
should be persisted using
the default summarization interval and should not be visible via JMX.name
- a name for the TimeStampedHistogram
(e.g.
"txPackets")public HistogramDescriptor build()
HistogramDescriptor
instance.build
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
HistogramDescriptor
public HistogramDescriptor.HistogramDescriptorBuilder appId(String toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.appId
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- application IDpublic HistogramDescriptor.HistogramDescriptorBuilder description(String toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.description
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- descriptionpublic HistogramDescriptor.HistogramDescriptorBuilder name(String toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that will be
built. Many metrics may have the same name (e.g. "txPackets") but
can be distinguished from one another via the primary and secondary
tags specified.name
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- namepublic HistogramDescriptor.HistogramDescriptorBuilder persist(boolean toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that will be built is to be persisted. true
indicates that
the value should be persisted, false
that it shouldn't.persist
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- persistence flagpublic HistogramDescriptor.HistogramDescriptorBuilder primaryTag(String toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that will be built. The tag can be anything that
is a useful identifier to group metrics by.primaryTag
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- primary tagpublic HistogramDescriptor.HistogramDescriptorBuilder publishToJmx(boolean toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that will be built should be made visible via JMX. true
indicates that the value should be visible, false
that it
shouldn't.publishToJmx
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- JMX flagpublic HistogramDescriptor.HistogramDescriptorBuilder secondaryTag(String toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that will be built. The tag can be anything that
is a useful identifier to group metrics by, but should make sense in
the context of the specified primary tag.secondaryTag
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- secondary tagpublic HistogramDescriptor.HistogramDescriptorBuilder summaryMinutes(MetricDescriptor.SummaryIntervalMinutes toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.summaryMinutes
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- summarization interval (in minutes)public HistogramDescriptor.HistogramDescriptorBuilder type(MetricDescriptor.Type toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.type
in class MetricDescriptor.MetricDescriptorBuilder<HistogramDescriptor>
toSet
- metric typeCopyright © 2016. All Rights Reserved.