One of the things the Pre-Deploy action does is determine the health of the system since the last deploy. This way, you know that any alerts the action reports on are in the current deploy and not from before that.
Deployment markers rely on version attributes (aka “release tags”) that you add to your service instrumentation. You then register that attribute with Lightstep so that it can collect that attribute data from your spans. When Lightstep finds a change in that attribute’s value, it creates a marker based on the timestamp of the span.
Instrument for Deployment Markers
Add an attribute (known as a
tag in OpenTracing) with values to your services that can be used to report version information.
For example, you might create an attribute 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 attributes.
The Instrumentation Quality Score checks for version attributesÍ on your services.
Register the Attribute with Lightstep
- 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 attributes found in your instrumentation. Select the version attribute from the list.
The attribute now displays as the Version Attribute.
What Did We Learn?
- Lightstep uses deployment markers to keep track of system health across deployments.
- Deployment markers use your instrumentation attributes to understand new versions.