Getting started

The main components of Lightbend Telemetry need to be installed, or integrated into your build, to enable telemetry for Akka.

This quick start guide takes you through the basic steps required to get your project up and running with Lightbend Telemetry.

  1. Make sure that you have Bintray credentials to get access to the required libraries.

  2. Setting up your project to use the Cinnamon Agent.

  3. Configuring Cinnamon Core and selecting actors for telemetry.

  4. Installing and configuring Backend Plugins.

Lightbend account - Bintray credentials

To gain access to Lightbend Telemetry you must first create a Lightbend account - or login if you already have an account.

Once you have logged in you should set up the Bintray credentials for your specific build tool (sbt, Maven or Gradle).

Using Lightbend Telemetry is free during development, but you must have a valid license to use it in production.

Cinnamon Agent

Lightbend Telemetry is currently only available for Akka and Lagom. To get started, you should configure your build to use the Cinnamon Agent for one of the following build systems: sbt, Maven, or Gradle.

Cinnamon Core

The heart of our system named “Cinnamon”, includes modules for selecting actors, reporting metrics and events, and tracing asynchronous message flows.

Since your application could create thousands or even tens of thousands of actors, the default setting is configured with actor telemetry turned off. You need to select which actors to observe in your application.conf file which is the same file used to set up your Akka system.

Here below is a simple example configuration to instrument all actors in the system grouped by actor class:

cinnamon.akka {
  actors {
    "/user/*" {
      report-by = class
    }
  }
}

For more information see Akka configuration, Akka HTTP configuration, or Lagom configuration.

Backend plugins

Lightbend Telemetry provides backend plugins for integrating with monitoring solutions and libraries for metrics and logging. Also, Telemetry supports multiple backend reporting, so you could configure one of the available backends to capture and process metrics while another handles events.

Let’s take a look at a sample application and what steps are needed to add Lightbend Telemetry for various build tools.