object CinnamonAttributes
Attributes for programmatic configuration of Cinnamon instrumentation for Akka Streams.
- Alphabetic
- By Inheritance
- CinnamonAttributes
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Type Members
- implicit class FlowWithInstrumented[In, Out, Mat] extends AnyRef
Implicit convenience extension for adding Instrumented attributes to flows.
- implicit class GraphWithInstrumented[Mat] extends AnyRef
Implicit convenience extension for adding Instrumented attributes to runnable graphs.
- final class Instrumented extends Attribute
Attribute for specifying Cinnamon instrumentation settings directly on a runnable graph.
- implicit class SourceWithInstrumented[Out, Mat] extends AnyRef
Implicit convenience extension for adding Instrumented attributes to sources.
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 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()
- def instrumented(reportByName: Boolean = false, reportByInstance: Boolean = false, name: String = null, tags: Map[String, String] = Map.empty, perOperator: Boolean = true, perConnection: Boolean = false, perBoundary: Boolean = false, perFlow: Boolean = false, substreams: Boolean = true, traceable: Boolean = false): Attributes
Create Instrumented Attributes for Cinnamon instrumentation settings.
Create Instrumented Attributes for Cinnamon instrumentation settings.
- reportByName
whether to report metrics by name (using name attribute on graph by default)
- reportByInstance
whether to report metrics by instance
- name
set reportByName and the reporting name directly (when non-null)
- tags
extra tags to be added to stream identity
- perOperator
whether to record metrics per-operator (throughput and processing time)
- perConnection
whether to record metrics per-connection (throughput and processing time)
- perBoundary
whether to record metrics per-boundary (throughput)
- perFlow
whether to record metrics per-flow (end-to-end flow time)
- substreams
whether to also instrument substreams materialized by this stream
- traceable
whether to include the stream in traces
- returns
Instrumented Attributes with Cinnamon settings
- def instrumentedByInstance(): Attributes
Java API: create Instrumented attribute with report by instance setting.
Java API: create Instrumented attribute with report by instance setting.
- returns
Attributes for instrumented with report by instance
- def instrumentedByName(name: String): Attributes
Java API: create Instrumented attribute with report by name setting.
Java API: create Instrumented attribute with report by name setting.
- name
name of graph to use for instrumentation
- returns
Attributes for instrumented with report by name
- def instrumentedByName(): Attributes
Java API: create Instrumented attribute with report by name setting (using name attribute on graph).
Java API: create Instrumented attribute with report by name setting (using name attribute on graph).
- returns
Attributes for instrumented with report by name
- def instrumentedByNameAndInstance(name: String): Attributes
Java API: create Instrumented attribute with both report by name and report by instance settings.
Java API: create Instrumented attribute with both report by name and report by instance settings.
- name
name of graph to use for instrumentation
- returns
Attributes for instrumented with report by name and instance
- def instrumentedByNameAndInstance(): Attributes
Java API: create Instrumented attribute with both report by name and report by instance settings.
Java API: create Instrumented attribute with both report by name and report by instance settings.
- returns
Attributes for instrumented with report by name and instance
- def instrumentedRunWith[Out, Mat1, Mat2](source: Graph[SourceShape[Out], Mat1], sink: Graph[SinkShape[Out], Mat2], materializer: Materializer, instrumented: Instrumented): Mat2
Java API: call runWith on a Source and Sink with instrumentation settings.
Java API: call runWith on a Source and Sink with instrumentation settings.
- source
the Source graph to be connected and run
- sink
the Sink graph to be connected using runWith
- materializer
the stream Materializer
- instrumented
the Instrumented attribute providing instrumentation settings
- returns
the materialized value of the Sink
- def instrumentedWith(reportByName: Boolean = false, reportByInstance: Boolean = false, name: String = null, tags: Map[String, String] = Map.empty, perOperator: Boolean = true, perConnection: Boolean = false, perBoundary: Boolean = false, perFlow: Boolean = false, substreams: Boolean = true, traceable: Boolean = false): Instrumented
Create Instrumented attribute for Cinnamon instrumentation settings.
Create Instrumented attribute for Cinnamon instrumentation settings.
- reportByName
whether to report metrics by name (using name attribute on graph by default)
- reportByInstance
whether to report metrics by instance
- name
set reportByName and the reporting name directly (when non-null)
- tags
extra tags to be added to stream identity
- perOperator
whether to record metrics per-operator (throughput and processing time)
- perConnection
whether to record metrics per-connection (throughput and processing time)
- perBoundary
whether to record metrics per-boundary (throughput)
- perFlow
whether to record metrics per-flow (end-to-end flow time)
- substreams
whether to also instrument substreams materialized by this stream
- traceable
whether to include the stream in traces
- returns
Instrumented attribute with Cinnamon settings
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isInstrumented(): Instrumented
Java API: create a new Instrumented attribute with default settings (telemetry not enabled).
Java API: create a new Instrumented attribute with default settings (telemetry not enabled).
- returns
default Instrumented attribute
- 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()
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- 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])
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.