OpsClarity

OpsClarity is part of Lightbend Monitoring, and together with Cinnamon provides an end-to-end monitoring solution for your Lightbend Platform applications.

As a Lightbend customer you have full access to OpsClarity, bundled with your subscription package. Contact us for more information.

Cinnamon dependency

First make sure that your build is configured to use the Cinnamon Agent and has the Akka instrumentation enabled.

Cinnamon provides a module that contains all the configuration required for reporting telemetry to OpsClarity via DogStatsD. Add the Cinnamon OpsClarity dependency to your build:

sbt
libraryDependencies += Cinnamon.library.cinnamonOpsClarity
Maven
<dependency>
  <groupId>com.lightbend.cinnamon</groupId>
  <artifactId>cinnamon-opsclarity_2.11</artifactId>
  <version>2.5.3</version>
</dependency>
Gradle
dependencies {
  compile group: 'com.lightbend.cinnamon', name: 'cinnamon-opsclarity_2.11', version: '2.5.3'
}

Configuration

The Cinnamon OpsClarity module contains all the default configuration required for reporting to OpsClarity via DogStatsD. You don’t need anything more to report to OpsClarity using the default settings.

The default settings can also be adjusted should you need to. In the Example tab there is example configuration to change which metric fields are reported:

Required

There is nothing to configure if you want to use the default OpsClarity settings that will communicate with localhost on port 10101.

Example
# Example configuration for adjusting reporting to OpsClarity
cinnamon.opsclarity {
  dogstatsd {
    report {
      histogram = ["max", "p99", "p999"]
      meter = ["samples"]
    }
  }
}
Reference
cinnamon.opsclarity {
  dogstatsd {
    # Host of DogStatsD collector for OpsClarity agent
    host = "127.0.0.1"

    # Port of DogStatsD collector for OpsClarity agent (default is 10101)
    port = 10101

    # Frequency of metric reporting to OpsClarity agent
    frequency = 10s

    report {
      # Histogram fields to report for metrics
      histogram = ["max", "mean", "min", "p95", "p99"]

      # Meter fields to report for metrics
      meter = ["min1_rate", "samples"]
    }

    # Prefix for all metric keys
    prefix = ""

    # Suffix for all metric keys
    suffix = ""

    # Tags for all metrics.
    # Uses a "key-value" approach to generate the tags.
    # E.g. the following configuration:
    # tags {
    #   country = "UK"
    # }
    # will generate tags = "country:UK"
    tags {}

    # Whether to include "unique dimensions" as tags.
    # These are tags that are unique to this reporter,
    # such as host name and application identifier.
    # Off by default for compatibility with earlier versions.
    # Note: host tag is also already provided by DogStatsD
    unique-dimensions = off
  }
}

Note: These settings are defined in the reference.conf. You only need to specify any of these settings when you want to override the defaults.