Migration guide

This is a guide for migrating from Lightbend Telemetry 2.13 to Lightbend Telemetry 2.14.

Telemetry Warnings

The following warnings may be emitted by Lightbend Telemetry:

Telemetry Akka streams configuration requires potential call-site lookups

When Telemetry checks if a stream is eligible for instrumentation, it first checks if the stream contains attributes specifying that it should be instrumented.

If these attributes are not found, Telemetry will then move on to checking if the stream should be instrumented potentially by name, or by materialized code location.

If your Telemetry configuration Akka streams configuration specifies any streams for inclusion or exclusion by their materialized code location, Telemetry will do a call-site lookup by checking the current call stack. Checking the call stack is a relatively expensive operation that will happen each time a stream is materialized that does not contain the Instrumented attribute.

To remove this warning, your Telemetry Akka streams configuration should prefer to include and exclude streams by name. Some examples are shown here.

Note: This warning can be suppressed, described in the Akka stream configuration documentation.

Available since Cinnamon 2.14.1

Cinnamon sbt plugin warnings

The follow warnings may be emitted by sbt:

Lightbend commercial resolver is missing.

This warning will appear if you include the Cinnamon sbt plugin and the plugin does not detect the required Lightbend commercial-releases repository configured as part of your dependency resolvers.

You can add the Lightbend commercial-releases repository to your project configuration by following the sbt section at the Lightbend platform credentials page.

Note: This warning can be suppressed by specifying cinnamonSuppressRepoWarnings := true in your sbt configuration.

Available since Cinnamon 2.13.4

Lightbend commercial resolver does not use new URL-based credential mechanism

This warning will appear if you include the Cinnamon sbt plugin and your project is configured to access the Lightbend commercial-releases repository using the old username and password based mechanism, typically where the username and password are stored in a credentials file such as ~/.lightbend/commercial.credentials.

Access to the commercial-releases repository is now granted via a unique URL containing an auth token for your account. You can find the resolver configuration for sbt, maven and gradle at the Lightbend platform credentials page.

The Lightbend platform credentials page also includes instruction for how to cleanup the old username and password based approach.

Note: This warning can be suppressed by specifying cinnamonSuppressRepoWarnings := true in your sbt configuration.

Available since Cinnamon 2.13.4

 OpenTracing upgraded to 0.32

Lightbend Telemetry version 2.14 upgrades its OpenTracing dependency to version 0.32

You may see deprecation warnings if you use the methods mentioned in the CHANGELOG. Jaeger (which covers Jaeger and Zipkin) and Datadog OpenTracing modules have been updated to their latest versions that support OpenTracing 0.32.

 Datadog OpenTracing upgraded to 0.43

As part of the OpenTracing upgrade to version 0.32, we have upgraded Datadog’s OpenTracing integration dependency to its latest version 0.43.

New configuration options are available, described in Datadog’s documentation. These options can be passed in to Datadog via your Lightbend telemetry configuration, described in the Lightbend Datadog OpenTracing documentation.

Renamed Datadog configuration keys

If you previously specified the configuration key cinnamon.opentracing.datadog.jmxfetch.metrics-configs you should now specify it as cinnamon.opentracing.datadog.jmxfetch.config.

Previous migration guide

Lightbend Telemetry 2.13 migration guide