final class Instrumented extends Attribute
Attribute for specifying Cinnamon instrumentation settings directly on a runnable graph.
- Alphabetic
 - By Inheritance
 
- Instrumented
 - Attribute
 - AnyRef
 - Any
 
- Hide All
 - Show All
 
- Public
 - Protected
 
Instance Constructors
Value Members
-   final  def !=(arg0: Any): Boolean
- Definition Classes
 - AnyRef → Any
 
 -   final  def ##: Int
- Definition Classes
 - AnyRef → Any
 
 -   final  def ==(arg0: Any): Boolean
- Definition Classes
 - AnyRef → Any
 
 -   final  def asInstanceOf[T0]: T0
- Definition Classes
 - Any
 
 -    def attributes(): Attributes
Java API: put this Instrumented attribute in an Attributes object.
Java API: put this Instrumented attribute in an Attributes object.
- returns
 new Attributes with this Instrumented attribute
 -    def clone(): AnyRef
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.CloneNotSupportedException]) @IntrinsicCandidate() @native()
 
 -   final  def eq(arg0: AnyRef): Boolean
- Definition Classes
 - AnyRef
 
 -    def equals(arg0: AnyRef): Boolean
- Definition Classes
 - AnyRef → Any
 
 -   final  def getClass(): Class[_ <: AnyRef]
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -    def hashCode(): Int
- Definition Classes
 - AnyRef → Any
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -   final  def isInstanceOf[T0]: Boolean
- Definition Classes
 - Any
 
 -  val name: Option[String]
 -   final  def ne(arg0: AnyRef): Boolean
- Definition Classes
 - AnyRef
 
 -   final  def notify(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -   final  def notifyAll(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @IntrinsicCandidate() @native()
 
 -  val perBoundary: Boolean
 -  val perConnection: Boolean
 -  val perFlow: Boolean
 -  val perOperator: Boolean
 -  val reportByInstance: Boolean
 -  val reportByName: Boolean
 -    def setTraceable(enabled: Boolean): Instrumented
Java API: set traceable instrumentation.
Java API: set traceable instrumentation.
- enabled
 whether traceable instrumentation is enabled
- returns
 new Instrumented attribute with traceable setting
 -    def setTraceable(): Instrumented
Java API: enable traceable instrumentation.
Java API: enable traceable instrumentation.
- returns
 new Instrumented attribute with traceable setting
 -  val substreams: Boolean
 -   final  def synchronized[T0](arg0: => T0): T0
- Definition Classes
 - AnyRef
 
 -  val tags: Map[String, String]
 -    def toString(): String
- Definition Classes
 - Instrumented → AnyRef → Any
 
 -  val traceable: Boolean
 -   final  def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.InterruptedException])
 
 -   final  def wait(arg0: Long): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.InterruptedException])
 
 -   final  def wait(): Unit
- Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.InterruptedException])
 
 -    def withName(name: String): Instrumented
Java API: set name for instrumentation.
Java API: set name for instrumentation.
- name
 name of graph to use for instrumentation
- returns
 new Instrumented attribute with name
 -    def withPerBoundary(enabled: Boolean): Instrumented
Java API: set per-boundary instrumentation.
Java API: set per-boundary instrumentation.
- enabled
 whether per-boundary instrumentation is enabled
- returns
 new Instrumented attribute with per-boundary setting
 -    def withPerBoundary(): Instrumented
Java API: enable per-boundary instrumentation.
Java API: enable per-boundary instrumentation.
- returns
 new Instrumented attribute with per-boundary setting
 -    def withPerConnection(enabled: Boolean): Instrumented
Java API: set per-connection instrumentation.
Java API: set per-connection instrumentation.
- enabled
 whether per-connection instrumentation is enabled
- returns
 new Instrumented attribute with per-connection setting
 -    def withPerConnection(): Instrumented
Java API: enable per-connection instrumentation.
Java API: enable per-connection instrumentation.
- returns
 new Instrumented attribute with per-connection setting
 -    def withPerFlow(enabled: Boolean): Instrumented
Java API: set per-flow instrumentation.
Java API: set per-flow instrumentation.
- enabled
 whether per-flow instrumentation is enabled
- returns
 new Instrumented attribute with per-flow setting
 -    def withPerFlow(): Instrumented
Java API: enable per-flow instrumentation.
Java API: enable per-flow instrumentation.
- returns
 new Instrumented attribute with per-flow setting
 -    def withPerOperator(enabled: Boolean): Instrumented
Java API: set per-operator instrumentation.
Java API: set per-operator instrumentation.
- enabled
 whether per-operator instrumentation is enabled
- returns
 new Instrumented attribute with per-operator setting
 -    def withPerOperator(): Instrumented
Java API: enable per-operator instrumentation.
Java API: enable per-operator instrumentation.
- returns
 new Instrumented attribute with per-operator setting
 -    def withReportByInstance(): Instrumented
Java API: set report by instance.
Java API: set report by instance.
- returns
 new Instrumented attribute with report by instance
 -    def withReportByName(name: String): Instrumented
Java API: set report by name and provide name.
Java API: set report by name and provide name.
- name
 name of graph to use for instrumentation
- returns
 new Instrumented attribute with report by name
 -    def withReportByName(): Instrumented
Java API: set report by name.
Java API: set report by name.
- returns
 new Instrumented attribute with report by name
 -    def withSubstreams(enabled: Boolean): Instrumented
Java API: set substreams instrumentation.
Java API: set substreams instrumentation.
- enabled
 whether substreams instrumentation is enabled
- returns
 new Instrumented attribute with substreams setting
 -    def withSubstreams(): Instrumented
Java API: enable substreams instrumentation.
Java API: enable substreams instrumentation.
- returns
 new Instrumented attribute with substreams setting
 -    def withTags(tags: Map[String, String]): Instrumented
Java API: set tags on stream identity.
Java API: set tags on stream identity.
- tags
 tags to be added to stream identity
- returns
 new Instrumented attribute with tags
 -    def withoutPerConnection(): Instrumented
Java API: disable per-connection instrumentation.
Java API: disable per-connection instrumentation.
- returns
 new Instrumented attribute with per-connection setting
 -    def withoutPerFlow(): Instrumented
Java API: disable per-flow instrumentation.
Java API: disable per-flow instrumentation.
- returns
 new Instrumented attribute with per-flow setting
 -    def withoutPerOperator(): Instrumented
Java API: disable per-operator instrumentation.
Java API: disable per-operator instrumentation.
- returns
 new Instrumented attribute with per-operator setting
 -    def withoutSubstreams(): Instrumented
Java API: disable substreams instrumentation.
Java API: disable substreams instrumentation.
- returns
 new Instrumented attribute with substreams setting
 
Deprecated Value Members
-    def finalize(): Unit
- Attributes
 - protected[lang]
 - Definition Classes
 - AnyRef
 - Annotations
 - @throws(classOf[java.lang.Throwable]) @Deprecated
 - Deprecated
 (Since version 9)
 
This is the public API for Cinnamon.
The com.lightbend.cinnamon package contains the public Cinnamon API.
See the complete list of Cinnamon packages on the right.
Cinnamon Events and Metrics
For the custom events API see
CinnamonEvents.For the custom metrics API see
CinnamonMetrics.Stopwatch
For the Stopwatch API see
Stopwatch.Coda Hale Metrics
For creating custom Coda Hale Metrics reporters see the com.lightbend.cinnamon.chmetrics.reporter package.