Features

This section contains an overview of the features available in Lightbend Telemetry.

Supported major versions are:

  • Scala 2.11 and Scala 2.12
  • Akka 2.4+
  • Akka HTTP 10.0.8+.
  • Play 2.6.
  • Lagom 1.x (with some specific metrics only available in 1.4+.)

See below for detailed information about the support.

Akka related information

Lightbend Telemetry captures a plentitude of actor related information such as mailbox size, time in mailbox, message processing time, stash size, unhandled messages, deadletters, to name a few.

More information about the Akka related metrics and events that Lightbend Telemetry supports can be found in the tables below.

Actor metrics

Metric Type Akka 2.4.x Akka 2.5.x
Mailbox size Recorder
Mailbox time Recorder
Processed msg Rate
Processing time Recorder
Running actors Counter
Sent msg Rate
Stash size Rate

Router metrics

Metric Type Akka 2.4.x Akka 2.5.x
Processed msg Rate
Processing time Recorder

Actor events

Event Type Akka 2.4.x Akka 2.5.x
Deadletter
Failure (exception)
Log error
Log warning
Unhandled msg

Remote actor metrics

Metric Type Akka 2.4.x Akka 2.5.x
Deserialization time Recorder
Phi accrual value GaugeDouble
Phi accrual threshold value GaugeDouble
Received msg Rate
Received msg size Recorder
Sent msg Rate
Sent msg size Recorder
Serialization time Recorder

Remote actor events

Event Type Akka 2.4.x Akka 2.5.x
Large msg received
Large msg sent
Node quarantined

Cluster related events

Event Type Akka 2.4.x Akka 2.5.x
Current cluster state event
Domain event
Member event
Singleton event
Shard region event
Event Type >= Akka 2.4.17 Akka 2.5.x
Node unable to join

Cluster related metrics

Metric Type Akka 2.4.x Akka 2.5.x
Shard region delivered messages Rate
Shards regions per node Gauge
Shards per shard region Gauge
Shards entities per shard Gauge
Reachable nodes Counter
Unreachable nodes Counter

Split Brain Resolver events

Event Type Akka 2.4.x Akka 2.5.x
SBR event

Akka Persistence metrics

Metrics generated related to Akka Persistence. RecoveryPermitter is an internal Akka actor that keeps track of the number of recovery permits available, for more information see Recovery.

Metric Type Akka 2.5.x
Persistence recovery time Recorder
Persistence recovery failure time Recorder
RecoveryPermitter used permits Recorder
RecoveryPermitter pending actors Recorder
RecoveryPermitter max permits value Gauge

Akka Persistence events

Event Type Akka 2.5.x
Persistence recovery failure
Persistence persist failure
Persistence persist rejection

Akka Stream metrics (core)

Metric Type Akka 2.5.x
Running streams Counter
Running operators per stream Counter
Running operators Counter
Stream throughput Rate
Operator throughput Rate
Operator processing time Recorder

Akka Stream events

Event Type Akka 2.5.x
Operator failure event

Akka Stream metrics (extended)

Metric Type Akka 2.5.x
Stream flow time Recorder
Stream flow active time Recorder
Stream flow efficiency Recorder
Operator flow time Recorder
Operator latency Recorder
Operator demand Rate
Operator demand processing time Recorder
Operator demand latency Recorder
Connection throughput Rate
Connection processing time Recorder
Connection latency Recorder
Connection demand Rate
Connection demand processing time Recorder
Connection demand latency Recorder

Akka HTTP/Play/Lagom server metrics

The following metrics are per Akka HTTP/Play server. There can be multiple servers running in one JVM.

Metric Type Akka HTTP 10.0.8+ Play 2.6+ Lagom 1.4+
Connections Rate
Requests Rate
Responses Rate
Responses 2xx Rate
Responses 3xx Rate
Responses 4xx Rate
Responses 5xx Rate
Response time Recorder
Response time 2xx Recorder
Response time 3xx Recorder
Response time 4xx Recorder
Response time 5xx Recorder

Akka HTTP/Play/Lagom server endpoint metrics

The following metrics are per endpoint and server. An endpoint corresponds to a URI, e.g. /users or /account.

Metric Type Akka HTTP 10.0.8+ Play 2.6+ Lagom 1.4+
Endpoint responses Rate
Endpoint response time Recorder

Akka Http/Play client metrics

The following metrics are per Akka Http/Play/Lagom client.

Metric Type Akka HTTP 10.0.8+ Play 2.6+ Lagom 1.4+
Client requests Rate
Client service response time Recorder

Lagom circuit breaker information

Lightbend’s Lagom framework for microservices contains built-in circuit breakers (CB) that represent the health of Lagom inter-service communication. When used in conjunction with Lightbend Telemetry, it becomes possible to gain insight into the behavior of these circuit breakers revealing their state, latency, and throughput.

More information about the Lagom related metrics and events that Lightbend Telemetry supports can be found in the tables below.

For more information, see Lagom instrumentation.

Circuit breaker metrics

Metric Type Lagom 1.x
Failure rate
Latency
Success
Throughput
Throughput failure

Circuit breaker events

Event Type Lagom 1.x
State change

Scala Future metrics

Metric Type Scala 2.11.x Scala 2.12.x
Created futures Rate
Completing time Recorder
Scheduled futures Recorder
Scheduling time Recorder
Processed futures Rate
Processing time Recorder