public static class MeterDescriptor.MeterDescriptorBuilder extends MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>
MeterDescriptor
be
specified during its own construction. Values may also be specified for
the optional arguments needed for a MeterDescriptor
, 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 |
---|
MeterDescriptor.MeterDescriptorBuilder(String name)
Creates a new
MeterDescriptor.MeterDescriptorBuilder using only the arguments
that are required to build a valid MeterDescriptor . |
Modifier and Type | Method and Description |
---|---|
MeterDescriptor.MeterDescriptorBuilder |
appId(String toSet)
Sets the application ID to apply to the
MetricDescriptor that
will be built. |
MeterDescriptor |
build()
Build a
MeterDescriptor instance. |
MeterDescriptor.MeterDescriptorBuilder |
description(String toSet)
Sets the description to apply to the
MetricDescriptor that
will be built. |
MeterDescriptor.MeterDescriptorBuilder |
name(String toSet)
Sets the name to apply to the
MetricDescriptor that will be
built. |
MeterDescriptor.MeterDescriptorBuilder |
persist(boolean toSet)
Sets the flag that indicates whether the
MetricDescriptor
that will be built is to be persisted. |
MeterDescriptor.MeterDescriptorBuilder |
primaryTag(String toSet)
Sets the primary tag (e.g.
|
MeterDescriptor.MeterDescriptorBuilder |
publishToJmx(boolean toSet)
Sets the flag that indicates whether the
MetricDescriptor
that will be built should be made visible via JMX. |
MeterDescriptor.MeterDescriptorBuilder |
secondaryTag(String toSet)
Sets the secondary tag (e.g.
|
MeterDescriptor.MeterDescriptorBuilder |
summaryMinutes(MetricDescriptor.SummaryIntervalMinutes toSet)
Sets the number of minutes that should elapse between the persistence
of summarized values to apply to the
MetricDescriptor that
will be built. |
MeterDescriptor.MeterDescriptorBuilder |
type(MetricDescriptor.Type toSet)
Sets the metric type to apply to the
MetricDescriptor that
will be built. |
public MeterDescriptor.MeterDescriptorBuilder(String name)
MeterDescriptor.MeterDescriptorBuilder
using only the arguments
that are required to build a valid MeterDescriptor
. If no
other fields are set via other methods before building, the resulting
MeterDescriptor
will specify a TimeStampedMeter
associated with no specific application, no primary or secondary
tags, no description, and that the resulting TimeStampedMeter
should be persisted using the default summarization interval and
should not be visible via JMX.name
- a name for the TimeStampedMeter
(e.g.
"txPacketRate")public MeterDescriptor build()
MeterDescriptor
instance.build
in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>
MeterDescriptor
public MeterDescriptor.MeterDescriptorBuilder appId(String toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.appId
in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>
toSet
- application IDpublic MeterDescriptor.MeterDescriptorBuilder description(String toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.description
in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>
toSet
- descriptionpublic MeterDescriptor.MeterDescriptorBuilder 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<MeterDescriptor>
toSet
- namepublic MeterDescriptor.MeterDescriptorBuilder 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<MeterDescriptor>
toSet
- persistence flagpublic MeterDescriptor.MeterDescriptorBuilder 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<MeterDescriptor>
toSet
- primary tagpublic MeterDescriptor.MeterDescriptorBuilder 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<MeterDescriptor>
toSet
- JMX flagpublic MeterDescriptor.MeterDescriptorBuilder 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<MeterDescriptor>
toSet
- secondary tagpublic MeterDescriptor.MeterDescriptorBuilder summaryMinutes(MetricDescriptor.SummaryIntervalMinutes toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.summaryMinutes
in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>
toSet
- summarization interval (in minutes)public MeterDescriptor.MeterDescriptorBuilder type(MetricDescriptor.Type toSet)
MetricDescriptor.MetricDescriptorBuilder
MetricDescriptor
that
will be built.type
in class MetricDescriptor.MetricDescriptorBuilder<MeterDescriptor>
toSet
- metric typeCopyright © 2015. All Rights Reserved.