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