Features

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

Supported major versions are:

  • Java 8 and 11
  • Scala 2.12 and 2.13
  • Akka 2.6+
  • Akka HTTP 10.1.10+
  • Play 2.8
  • Lagom 1.6+

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.6.1+, 2.7.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.6.1+, 2.7.x
Processed msg Rate √
Processing time Recorder √

Actor events

Event Type Akka 2.6.1+, 2.7.x
Deadletter √
Failure (exception) √
Log error √
Log warning √
Unhandled msg √

Remote actor metrics

Metric Type Akka 2.6.1+, 2.7.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.6.1+, 2.7.x
Large msg received √
Large msg sent √
Node quarantined √

Cluster related events

Event Type Akka 2.6.1+, 2.7.x
Current cluster state event √
Domain event √
Member event √
Singleton event √
Shard region event √
Event Type Akka 2.6.1+, 2.7.x
Node unable to join √

Cluster related metrics

Metric Type Akka 2.6.1+, 2.7.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.6.1+, 2.7.x
SBR event √

Ask Pattern

Availability

Available since Cinnamon 2.14.0

Ask Pattern metrics

Some Ask Pattern metrics (marked with *) support opt-in automatic dimensions. It allows to collect metrics by the message type. In order to enable it see the Ask Pattern message type dimensions.

Metric Type Akka 2.6.1+, 2.7.x
Asked requests* Rate √
Expired requests* Rate √
Expired requests by-timeout Rate √
Success response time* Recorder √
Late response time* Recorder √

Ask Pattern events

Event Type Akka 2.6.1+, 2.7.x
Request failed √
Request expired √

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.

Some Akka Persistence metrics (marked with *) support opt-in automatic dimensions. It allows to collect metrics by the command type and by the event type depending on the metric. In order to enable it see the Akka Persistence automatic dimensions.

Metric Type Akka 2.6.1+, 2.7.x
Active entities Gauge √
Received commands* Gauge √
Persistence command time in stash* Recorder √
Persistence command processing time* Recorder √
Persistence recovery time Recorder √
Persistence recovery failure time Recorder √
Persisted events* Gauge √
Persistence event time* Recorder √
RecoveryPermitter used permits Recorder √
RecoveryPermitter pending actors Recorder √
RecoveryPermitter max permits value Gauge √

Akka Persistence events

Event Type Akka 2.6.1+, 2.7.x
Persistence recovery failure √
Persistence persist failure √
Persistence persist rejection √

Akka Projection metrics

Metrics generated related to Akka Projection.

Metric Type Akka Projection 1.0.0+
Active projections Gauge √
Processed envelopes Gauge √
Offsets committed Gauge √
Wait time Recorder √
Service time Recorder √
Residence time Recorder √

Akka Projection events

Event Type Akka Projection 1.0.0+
Processing error √
Projection failure √

Akka Stream metrics (core)

Metric Type Akka 2.6.1+, 2.7.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.6.1+, 2.7.x
Operator failure event √

Akka Stream metrics (extended)

Metric Type Akka 2.6.1+, 2.7.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.1.10+ Play 2.8+ Lagom 1.6+
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.1.10+ Play 2.8+ Lagom 1.6+
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.1.10+ Play 2.8+ Lagom 1.6+
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.6+
Failure rate Rate √
Latency Recorder √
Success Rate √
Throughput Rate √
State of circuit breaker GaugeLong √

Circuit breaker events

Event Type Lagom 1.6+
State change √

Lagom Projection

Availability

Available since Cinnamon 2.14.0

Lagom Projection metrics

Metric Type Lagom 1.6.2+
Event processed successfully Counter √
Event process failures Rate √
Query Latency Recorder √
Processing Time Recorder √
Latency Recorder √

Lagom Projection events

Event Type Lagom 1.6.2+
Failure √

Scala Future metrics

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

Java Future metrics

Metric Type Java 8 Java 11
Created futures Rate √ √
Completing time Recorder √ √
Scheduled futures Recorder √ √
Scheduling time Recorder √ √
Processed futures Rate √ √
Processing time Recorder √ √