com.netflix.spectator.api

Interface Id

All Superinterfaces:

Comparable<TagList>, Iterable<Tag>, TagList

public interface Id
extends TagList

Identifier for a meter or measurement.

Method Summary

Modifier and Type	Method and Description
static Id	create(String name) Create an immutable Id with the provided name.
default Id	filter(BiPredicate<String,String> predicate) Return a new tag list with only tags that match the predicate.
default Id	filterByKey(Predicate<String> predicate) Return a new tag list with only tags with keys that match the predicate.
default String	getKey(int i) Return the key at the specified index.
default String	getValue(int i) Return the value at the specified index.
String	name() Description of the measurement that is being collected.
default int	size() Return the size, number of tags, for the id including the name.
Iterable<Tag>	tags() Other dimensions that can be used to classify the measurement.
static Id	unsafeCreate(String name, String[] tags, int length) Warning: This method can be used to get better performance for some critical use-cases, but also has increased risk.
default Id	withTag(String k, boolean v) Return a new id with an additional tag value using Boolean.toString(boolean) to convert the boolean value to a string representation.
default <E extends Enum<E>> Id	withTag(String k, Enum<E> v) Return a new id with an additional tag value using Enum.name() to convert the Enum to a string representation.
Id	withTag(String k, String v) Return a new id with an additional tag value.
Id	withTag(Tag t) Return a new id with an additional tag value.
default Id	withTags(Iterable<Tag> tags) Return a new id with additional tag values.
default Id	withTags(Map<String,String> tags) Return a new id with additional tag values.
default Id	withTags(String... tags) Return a new id with additional tag values.
default Id	withTags(String k1, String v1) Return a new id with additional tag values.
default Id	withTags(String k1, String v1, String k2, String v2) Return a new id with additional tag values.
default Id	withTags(String k1, String v1, String k2, String v2, String k3, String v3) Return a new id with additional tag values.
default Id	withTags(Tag... tags) Return a new id with additional tag values.

Methods inherited from interface com.netflix.spectator.api.TagList

compareTo, create, forEach, getTag, iterator, spliterator

Methods inherited from interface java.lang.Iterable

forEach

Method Detail

name

String name()

Description of the measurement that is being collected.

tags

Iterable<Tag> tags()

Other dimensions that can be used to classify the measurement.

withTag

Id withTag(String k,
           String v)

Return a new id with an additional tag value.

withTag

Id withTag(Tag t)

Return a new id with an additional tag value.

withTag

default Id withTag(String k,
                   boolean v)

Return a new id with an additional tag value using Boolean.toString(boolean) to convert the boolean value to a string representation. This is merely a convenience function for:

   id.withTag("key", Boolean.toString(value))
 

withTag

default <E extends Enum<E>> Id withTag(String k,
                                       Enum<E> v)

Return a new id with an additional tag value using Enum.name() to convert the Enum to a string representation. This is merely a convenience function for:

   id.withTag("key", myEnum.name())
 

withTags

default Id withTags(String k1,
                    String v1)

Return a new id with additional tag values. This overload is to avoid allocating a parameters array for the more generic varargs method withTags(String...).

withTags

default Id withTags(String k1,
                    String v1,
                    String k2,
                    String v2)

Return a new id with additional tag values. This overload is to avoid allocating a parameters array for the more generic varargs method withTags(String...).

withTags

default Id withTags(String k1,
                    String v1,
                    String k2,
                    String v2,
                    String k3,
                    String v3)

Return a new id with additional tag values. This overload is to avoid allocating a parameters array for the more generic varargs method withTags(String...).

withTags

default Id withTags(String... tags)

Return a new id with additional tag values.

withTags

default Id withTags(Tag... tags)

Return a new id with additional tag values.

withTags

default Id withTags(Iterable<Tag> tags)

Return a new id with additional tag values.

withTags

default Id withTags(Map<String,String> tags)

Return a new id with additional tag values. If using a ConcurrentMap, note that the map should not be concurrently modified during this call. It is up to the user to ensure that it contains the correct set of tags that should be added to the id before and for the entire duration of the call until the new id is returned.

getKey

default String getKey(int i)

Return the key at the specified index. The name will be treated as position 0.

Specified by:

getKey in interface TagList

getValue

default String getValue(int i)

Return the value at the specified index. The name will be treated as position 0.

Specified by:

getValue in interface TagList

size

default int size()

Return the size, number of tags, for the id including the name.

Specified by:

size in interface TagList

filter

default Id filter(BiPredicate<String,String> predicate)

Return a new tag list with only tags that match the predicate.

Specified by:

filter in interface TagList

filterByKey

default Id filterByKey(Predicate<String> predicate)

Return a new tag list with only tags with keys that match the predicate.

Specified by:

filterByKey in interface TagList

create

static Id create(String name)

Create an immutable Id with the provided name. In many cases it is preferable to use Registry.createId(String) instead so that the overhead for instrumentation can be mostly removed when choosing to use a NoopRegistry. Using this method directly the Id will always be created.

unsafeCreate

static Id unsafeCreate(String name,
                       String[] tags,
                       int length)

Warning: This method can be used to get better performance for some critical use-cases, but also has increased risk. If there is any doubt, then use create(String) instead.

Create a new id using the name tag set. The provided array will be used directly so it should not be modified after. Caller must ensure that:

• Length of tags array is even.
• There are no null values for the first length entries in the array.