When you implement a tag to display versions of your service, a deployment marker displays at the time the deployment occurred. In the example below, a deploy of the inventory service occurred at around 2:20 pm. Hover over the marker in the larger charts to view details. These markers allow you to quickly correlate deployment with a possible regression.

Instrument for Deployment Markers

If you’re using the sample app, it’s already instrumented using the service.version attribute. You can skip to the Register Your Deployment Marker.

Add a tag (known as an attribute in OpenTelemetry) with values to your services that can be used to report version information.

For example, you might create a tag named service.version with values equal to the Git commit hash of the current version.

For optimal discoverability in Lightstep, we recommend that you use the Git commit hash or a Docker container tag, rather than semantic versions.

See the individual language Quick Start topics for instructions on how to create tags.

Register Your Deployment Marker

Deployment markers are project-specific. You need to register the version tags with all projects that should use them.

  1. In Lightstep, click Settings to open your project’s settings page.
  2. On the Project Settings page, scroll down to Deployment Settings.
  3. Click the + icon. A dropdown shows all tags found in your instrumentation. Select the tag from the list.

The tag now displays as the Version Tag.

If you’re using the sample app, you should see the tag service_version. Select that to use as your version tag.

What Did We Learn?

  • You can create a tag to hold the value of a service’s version.
  • When you register a tag with Lightstep, it can create deployment markers on the charts in the Service Health view.