trait Registrant extends AnyRef
User API for adding metrics registrants. A registrant can return metric sets that will be added to the common metrics registry that is sent to the reporters allowing additional metrics to be reported via the same mechanism.
Make sure that your registrant implements this interface.
The constructor of your registrant class must have one of the following constructors:
public YourRegistrant()
public YourRegistrant(com.typesafe.config.Config config)
Errors will be logged if the class does not have any acceptable constructors or if it does not implement this interface.
- Alphabetic
- By Inheritance
- Registrant
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Abstract Value Members
-
abstract
def
start(): Array[MetricSet]
Life cycle method called when telemetry is initiated.
Life cycle method called when telemetry is initiated.
- returns
the metric sets to add to the common metrics registry sent to the metrics reporters.
-
abstract
def
stop(): Unit
Life cycle method called when telemetry is stopped.
Concrete 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( ... ) @native() @IntrinsicCandidate()
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @IntrinsicCandidate()
-
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( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
Deprecated Value Members
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] ) @Deprecated
- Deprecated
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.