com.lightbend.cinnamon.akka.stream

Class CinnamonAttributes.Instrumented

java.lang.Object

com.lightbend.cinnamon.akka.stream.CinnamonAttributes.Instrumented

All Implemented Interfaces:

akka.stream.Attributes.Attribute

Enclosing class:

CinnamonAttributes

public static final class CinnamonAttributes.Instrumented
extends java.lang.Object
implements akka.stream.Attributes.Attribute

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

Constructor Summary

Constructors

Constructor and Description
Instrumented()
Instrumented(boolean reportByName, boolean reportByInstance, scala.Option<java.lang.String> name, scala.collection.immutable.Map<java.lang.String,java.lang.String> tags, boolean perOperator, boolean perConnection, boolean perBoundary, boolean perFlow, boolean substreams, boolean traceable)

Method Summary

Modifier and Type	Method and Description
akka.stream.Attributes	attributes() Java API: put this Instrumented attribute in an Attributes object.
scala.Option<java.lang.String>	name()
boolean	perBoundary()
boolean	perConnection()
boolean	perFlow()
boolean	perOperator()
boolean	reportByInstance()
boolean	reportByName()
CinnamonAttributes.Instrumented	setTraceable() Java API: enable traceable instrumentation.
CinnamonAttributes.Instrumented	setTraceable(boolean enabled) Java API: set traceable instrumentation.
boolean	substreams()
scala.collection.immutable.Map<java.lang.String,java.lang.String>	tags()
java.lang.String	toString()
boolean	traceable()
CinnamonAttributes.Instrumented	withName(java.lang.String name) Java API: set name for instrumentation.
CinnamonAttributes.Instrumented	withoutPerConnection() Java API: disable per-connection instrumentation.
CinnamonAttributes.Instrumented	withoutPerFlow() Java API: disable per-flow instrumentation.
CinnamonAttributes.Instrumented	withoutPerOperator() Java API: disable per-operator instrumentation.
CinnamonAttributes.Instrumented	withoutSubstreams() Java API: disable substreams instrumentation.
CinnamonAttributes.Instrumented	withPerBoundary() Java API: enable per-boundary instrumentation.
CinnamonAttributes.Instrumented	withPerBoundary(boolean enabled) Java API: set per-boundary instrumentation.
CinnamonAttributes.Instrumented	withPerConnection() Java API: enable per-connection instrumentation.
CinnamonAttributes.Instrumented	withPerConnection(boolean enabled) Java API: set per-connection instrumentation.
CinnamonAttributes.Instrumented	withPerFlow() Java API: enable per-flow instrumentation.
CinnamonAttributes.Instrumented	withPerFlow(boolean enabled) Java API: set per-flow instrumentation.
CinnamonAttributes.Instrumented	withPerOperator() Java API: enable per-operator instrumentation.
CinnamonAttributes.Instrumented	withPerOperator(boolean enabled) Java API: set per-operator instrumentation.
CinnamonAttributes.Instrumented	withReportByInstance() Java API: set report by instance.
CinnamonAttributes.Instrumented	withReportByName() Java API: set report by name.
CinnamonAttributes.Instrumented	withReportByName(java.lang.String name) Java API: set report by name and provide name.
CinnamonAttributes.Instrumented	withSubstreams() Java API: enable substreams instrumentation.
CinnamonAttributes.Instrumented	withSubstreams(boolean enabled) Java API: set substreams instrumentation.
CinnamonAttributes.Instrumented	withTags(java.util.Map<java.lang.String,java.lang.String> tags) Java API: set tags on stream identity.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

Instrumented

public Instrumented(boolean reportByName,
                    boolean reportByInstance,
                    scala.Option<java.lang.String> name,
                    scala.collection.immutable.Map<java.lang.String,java.lang.String> tags,
                    boolean perOperator,
                    boolean perConnection,
                    boolean perBoundary,
                    boolean perFlow,
                    boolean substreams,
                    boolean traceable)

Instrumented

public Instrumented()

Method Detail

attributes

public akka.stream.Attributes attributes()

Java API: put this Instrumented attribute in an Attributes object.

Returns:

new Attributes with this Instrumented attribute

name

public scala.Option<java.lang.String> name()

perBoundary

public boolean perBoundary()

perConnection

public boolean perConnection()

perFlow

public boolean perFlow()

perOperator

public boolean perOperator()

reportByInstance

public boolean reportByInstance()

reportByName

public boolean reportByName()

setTraceable

public CinnamonAttributes.Instrumented setTraceable()

Java API: enable traceable instrumentation.

Returns:

new Instrumented attribute with traceable setting

setTraceable

public CinnamonAttributes.Instrumented setTraceable(boolean enabled)

Java API: set traceable instrumentation.

Parameters:

enabled - whether traceable instrumentation is enabled

Returns:

new Instrumented attribute with traceable setting

substreams

public boolean substreams()

tags

public scala.collection.immutable.Map<java.lang.String,java.lang.String> tags()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

traceable

public boolean traceable()

withName

public CinnamonAttributes.Instrumented withName(java.lang.String name)

Java API: set name for instrumentation.

Parameters:

name - name of graph to use for instrumentation

Returns:

new Instrumented attribute with name

withPerBoundary

public CinnamonAttributes.Instrumented withPerBoundary()

Java API: enable per-boundary instrumentation.

Returns:

new Instrumented attribute with per-boundary setting

withPerBoundary

public CinnamonAttributes.Instrumented withPerBoundary(boolean enabled)

Java API: set per-boundary instrumentation.

Parameters:

enabled - whether per-boundary instrumentation is enabled

Returns:

new Instrumented attribute with per-boundary setting

withPerConnection

public CinnamonAttributes.Instrumented withPerConnection()

Java API: enable per-connection instrumentation.

Returns:

new Instrumented attribute with per-connection setting

withPerConnection

public CinnamonAttributes.Instrumented withPerConnection(boolean enabled)

Java API: set per-connection instrumentation.

Parameters:

enabled - whether per-connection instrumentation is enabled

Returns:

new Instrumented attribute with per-connection setting

withPerFlow

public CinnamonAttributes.Instrumented withPerFlow()

Java API: enable per-flow instrumentation.

Returns:

new Instrumented attribute with per-flow setting

withPerFlow

public CinnamonAttributes.Instrumented withPerFlow(boolean enabled)

Java API: set per-flow instrumentation.

Parameters:

enabled - whether per-flow instrumentation is enabled

Returns:

new Instrumented attribute with per-flow setting

withPerOperator

public CinnamonAttributes.Instrumented withPerOperator()

Java API: enable per-operator instrumentation.

Returns:

new Instrumented attribute with per-operator setting

withPerOperator

public CinnamonAttributes.Instrumented withPerOperator(boolean enabled)

Java API: set per-operator instrumentation.

Parameters:

enabled - whether per-operator instrumentation is enabled

Returns:

new Instrumented attribute with per-operator setting

withReportByInstance

public CinnamonAttributes.Instrumented withReportByInstance()

Java API: set report by instance.

Returns:

new Instrumented attribute with report by instance

withReportByName

public CinnamonAttributes.Instrumented withReportByName()

Java API: set report by name.

Returns:

new Instrumented attribute with report by name

withReportByName

public CinnamonAttributes.Instrumented withReportByName(java.lang.String name)

Java API: set report by name and provide name.

Parameters:

name - name of graph to use for instrumentation

Returns:

new Instrumented attribute with report by name

withSubstreams

public CinnamonAttributes.Instrumented withSubstreams()

Java API: enable substreams instrumentation.

Returns:

new Instrumented attribute with substreams setting

withSubstreams

public CinnamonAttributes.Instrumented withSubstreams(boolean enabled)

Java API: set substreams instrumentation.

Parameters:

enabled - whether substreams instrumentation is enabled

Returns:

new Instrumented attribute with substreams setting

withTags

public CinnamonAttributes.Instrumented withTags(java.util.Map<java.lang.String,java.lang.String> tags)

Java API: set tags on stream identity.

Parameters:

tags - tags to be added to stream identity

Returns:

new Instrumented attribute with tags

withoutPerConnection

public CinnamonAttributes.Instrumented withoutPerConnection()

Java API: disable per-connection instrumentation.

Returns:

new Instrumented attribute with per-connection setting

withoutPerFlow

public CinnamonAttributes.Instrumented withoutPerFlow()

Java API: disable per-flow instrumentation.

Returns:

new Instrumented attribute with per-flow setting

withoutPerOperator

public CinnamonAttributes.Instrumented withoutPerOperator()

Java API: disable per-operator instrumentation.

Returns:

new Instrumented attribute with per-operator setting

withoutSubstreams

public CinnamonAttributes.Instrumented withoutSubstreams()

Java API: disable substreams instrumentation.

Returns:

new Instrumented attribute with substreams setting