Migration guide

This is a guide for migrating from Lightbend Telemetry 2.11 to Lightbend Telemetry 2.12.

Module and dependency changes

Extracted Cinnamon Akka Persistence

The Cinnamon Akka Persistence has been extracted into a separate module. As of this version this dependency has to be added explicitly to enable persistence metrics and events. See Akka Persistence for more details.

Cinnamon Akka Persistence settings changes

The setting in the next table for enabling/disabling persistence metrics/events have been removed. Now the metrics and events are collected only for Persistent actors and configured separately from the other actors. See Persistent Actor configuration for more details.

Removed setting:
cinnamon.akka.persistence.events
cinnamon.akka.persistence.metrics

Also some meta descriptor settings have been renamed:

Obsolete setting prefixed with: cinnamon.akka.meta.descriptor New setting prefixed with: cinnamon.akka.persistence.meta.descriptor
persistence.recovery-permitter-max-permits-value max-permits
persistence.recovery-permitter-used-permits-value used-permits
persistence.recovery-permitter-pending-actors-value pending-entities
actor.persistence-recovery-time recovery-time
actor.persistence-recovery-failure-time recovery-failure-time
actor.persistence-recovery-failed recovery-failed
actor.persistence-persist-failed persist-failed
actor.persistence-persist-rejected persist-rejected

Note: Cinnamon Agent will warn you at the startup if it finds any of the deprecated settings.

Renamed Cinnamon Akka Persistence metrics

Obsolete Prometheus metric New Prometheus metric
akka_recovery_permitter_max_permits_value akka_recovery_permitter_max_permits
akka_recovery_permitter_used_permits_value akka_recovery_permitter_used_permits
akka_recovery_permitter_pending_actors_value akka_recovery_permitter_pending_entities
akka_actor_persistence_recovery_time_ns akka_entity_recovery_time_ns
akka_actor_persistence_recovery_failure_time_ns akka_entity_recovery_failure_time_ns
Obsolete Elasticsearch metric New Elasticsearch metric
metrics.recovery-permitter-max-permits-value recovery-permitter.max-permits
metrics.recovery-permitter-used-permits-value recovery-permitter.used-permits
metrics.recovery-permitter-pending-actors-value recovery-permitter.pending-entities
actors.persistence-recovery-time entities.recovery-time
actors.persistence-recovery-failure-time entities.recovery-failure-time
Obsolete Graphite metric New Graphite metric
RecoveryPermitter.recovery-permitter-max-permits-value recovery-permitter.max-permits
RecoveryPermitter.recovery-permitter-used-permits-value recovery-permitter.used-permits
RecoveryPermitter.recovery-permitter-pending-actors-value recovery-permitter.pending-entities
actors.*.persistence-recovery-time entities.*.recovery-time
actors.*.persistence-recovery-failure-time entities.*.recovery-failure-time

Note: These changes are only important if you use custom Grafana dashboards otherwise just update to the new Grafana dashboards.

OpsClarity module removed

The OpsClarity reporter module has been removed.

Lightbend Console provides a set of built in monitors and dashboards for Telemetry-instrumented applications.

Actor metrics

Sampling for mailbox size and stash size

The actor mailbox size and stash size metrics are now sampled, every 1 second by default, to avoid skew in the recorded distributions. The sampling period can be configured.

Previous migration guide

Lightbend Telemetry 2.11 migration guide