Packages

o

com.lightbend.cinnamon.akka.stream

CinnamonAttributes

object CinnamonAttributes

Attributes for programmatic configuration of Cinnamon instrumentation for Akka Streams.

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

Type Members

  1. implicit class FlowWithInstrumented[In, Out, Mat] extends AnyRef

    Implicit convenience extension for adding Instrumented attributes to flows.

  2. implicit class GraphWithInstrumented[Mat] extends AnyRef

    Implicit convenience extension for adding Instrumented attributes to runnable graphs.

  3. final class Instrumented extends Attribute

    Attribute for specifying Cinnamon instrumentation settings directly on a runnable graph.

  4. implicit class SourceWithInstrumented[Out, Mat] extends AnyRef

    Implicit convenience extension for adding Instrumented attributes to sources.

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 clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @IntrinsicCandidate()
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  9. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  10. 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

  11. 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

  12. 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

  13. 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

  14. 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

  15. 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

  16. 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

  17. 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

  18. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  19. 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

  20. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  21. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  22. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  23. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  24. def toString(): String
    Definition Classes
    AnyRef → Any
  25. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  26. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  27. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Deprecated Value Members

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

Inherited from AnyRef

Inherited from Any

Ungrouped