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.
When you have multiple versions in a time window, you can view the performance of each deployed version. For example, in this image, multiple versions have been deployed. Hover over the chart to see the percentage of traffic in each version.
This feature requires a Satellite upgrade to the March 2020 release.
For more information about how deployment markers can be used during root cause analysis, see Monitor Deployments.
Deployment markers rely on version tags (aka “release tags”) that you add to your service instrumentation. You then register that tag with Lightstep so that it can collect that tag data from your spans. When Lightstep finds a change in that tag’s value, it creates a marker based on the timestamp of the span.
Instrument for Deployment Markers
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.
The Instrumentation Quality Score checks for version tags on your services.
Register the Tag with Lightstep.
Deployment markers are project-specific. You need to register the version tags with all projects that should use them.
- Click Settings to open your project’s settings page.
- On the Project Settings page, scroll down to Deployment Settings.
- 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.