Packages

class Identity extends AnyRef

General purpose identity for instrumented entities.

Entities can be identified by class (only has a class), instance (has both class and name), or group (only has a name).

Identities belong to a category, for grouping instruments into categories like 'actors' or 'dispatchers'. Expressed in plural form.

Identities have a key, used for tags.

Identities can be organised in hierarchies, where each identity can have a parent identity, for forming full identifier keys.

Identities can be hidden, where they are in the hierarchy but not used.

Identities can be marked as being 'unique', unique to this instance of Cinnamon, such as host name and application identifier.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Identity
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Identity(builder: Builder)
    Attributes
    protected[meta]

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def builder(): Builder

    Create a new identity builder, based on this identity.

    Create a new identity builder, based on this identity.

    returns

    new Identity.Builder to create new identity

  6. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
  7. def copyToBuilder(builder: Builder): Builder
    Attributes
    protected[meta]
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(o: AnyRef): Boolean
    Definition Classes
    Identity → AnyRef → Any
    Annotations
    @Override()
  10. def getCategory(): String

    The category for this identity (used for grouping, expressed in plural form).

    The category for this identity (used for grouping, expressed in plural form). May be null.

    returns

    String category for this identity, or null if not present

  11. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @IntrinsicCandidate() @native()
  12. def getEntityClass(): Class

    The entity class for this identity.

    The entity class for this identity. May be null.

    returns

    Class for this identity, or null if not present

  13. def getEntityName(): String

    The entity name for this identity (for instance or group identities).

    The entity name for this identity (for instance or group identities). May be null.

    returns

    String name for this identity, or null if not present

  14. def getKey(): String

    The key for this identity (used for tags).

    The key for this identity (used for tags). May be null.

    returns

    String key for this identity, or null if not present

  15. def getName(): String

    Get the entity name (for instance or group) otherwise get the entity class name.

    Get the entity name (for instance or group) otherwise get the entity class name.

    returns

    String either the name or class name for this identity

  16. def getParent(): Identity

    The enclosing parent identity for this identity.

    The enclosing parent identity for this identity. May be null.

    returns

    Identity parent for this identity, or null if not present

  17. def getTags(): Map[String, String]

    The tags for this identity.

    The tags for this identity. Used in both the metric key and metric tags.

    returns

    Map of tags.

  18. def hasCategory(): Boolean

    Whether this identity has an associated category (used for grouping, expressed in plural form).

    Whether this identity has an associated category (used for grouping, expressed in plural form).

    returns

    boolean whether a category is specified

  19. def hasEntityClass(): Boolean

    Whether this identity has an associated entity class.

    Whether this identity has an associated entity class.

    returns

    boolean whether a class is specified

  20. def hasEntityName(): Boolean

    Whether this identity has an associated entity name (for instance or group identities).

    Whether this identity has an associated entity name (for instance or group identities).

    returns

    boolean whether a name is specified

  21. def hasKey(): Boolean

    Whether this identity has an associated key (used for tags).

    Whether this identity has an associated key (used for tags).

    returns

    boolean whether a key is specified

  22. def hasName(): Boolean

    Whether this identity has an associated name (either entity name or entity class).

    Whether this identity has an associated name (either entity name or entity class).

    returns

    boolean whether a name is specified

  23. def hasParent(): Boolean

    Whether this identity has an enclosing parent identity.

    Whether this identity has an enclosing parent identity.

    returns

    boolean whether parent identity is specified

  24. def hashCode(): Int
    Definition Classes
    Identity → AnyRef → Any
    Annotations
    @Override()
  25. def isDestroyable(): Boolean

    Whether instruments for this identity can be destroyed, once the entity for this identity has terminated in some way.

    Whether instruments for this identity can be destroyed, once the entity for this identity has terminated in some way.

    Instance identities are destroyable, while class and group identities are assumed to be not destroyable given that other instances with the same identity could still continue to exist.

    returns

    boolean whether this identity is destroyable

  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. def isUnique(): Boolean

    Whether this identity is unique to this instance of Cinnamon, such as host name or application identifier.

    Whether this identity is unique to this instance of Cinnamon, such as host name or application identifier.

    returns

    boolean whether this identity is unique

  28. def isVisible(): Boolean

    Whether this identity is visible, and should be included in metric keys or tags.

    Whether this identity is visible, and should be included in metric keys or tags.

    returns

    boolean whether this identity is visible

  29. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  30. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  31. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @IntrinsicCandidate() @native()
  32. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  33. def toString(): String
    Definition Classes
    Identity → AnyRef → Any
    Annotations
    @Override()
  34. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  35. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  36. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

    (Since version 9)

Inherited from AnyRef

Inherited from Any

Ungrouped