Streams are span queries that retain their data beyond the default three-day Microsatellites retention window. They allow you to proactively monitor parts of your system that are crucial to business health. Lightstep continuously receives data from your Microsatellites that match the query and stores statistics and example traces to ensure you always have data for latency, error rate, and operation rate for as long as your Data Retention policy allows.
Queries for alerts are automatically saved as Streams.
The Streams list shows all Streams that currently exist for the project. For each Stream, you can view when data was last received for it, the date it was created, and who created it.
Create a Stream
You create a Stream based on queries to your span data. Lightstep continuously monitors for span data that matches that query and saves it as a Stream. You can create a Stream:
- When you create a query for a chart on a dashboard
- From the Service Directory
- From a query in Explorer
- From the Streams list view
Use our public API to list, retrieve, update, and create Streams. You can also retrieve a specific time series for a Stream.
Create a Stream from the Query Builder in a dashboard
By default, the query for a dashboard chart is continuously collected and saved as a Stream and collects data about latency, error rate, and operation rate (regardless of the aggregate selected in the original query). You can instead choose to only display data from the Microsatellites’ retention window (by default, the last three days of data). Unselect the Create Stream checkbox to keep the data from being retained as a Stream.
When you view a Stream in a notebook or dashboard, three charts are created: latency, error rate, and operation rate.
Create a Stream from the Service directory
You can create a Stream for a service/operation pair from the Operations tab of the Service Directory.
From the Service Directory, click the Operations tab and choose a service on the left.
To create a Stream for an operation on a service, click Create Stream for that operation (if the button says View Stream then a stream has already been created for this operation).
By default, the Stream’s name is the query. You can rename it
Click View Stream to add a Stream to a dashboard or notebook.
When you add a Stream to a notebook or dashboard, three charts are created (latency, error rate, and operation rate) using the query for the operation on the service. You can edit the queries as needed and view exemplar traces.
By default, the charts take the name of the query. You can change that to be more descriptive by clicking into the title and entering a name of your choice.
Create a Stream from Explorer
Open Explorer from the navigation bar and run any query.
Learn how to run a query
To run a query using the Query Builder:
Click into the search bar to open the Query Builder. You can build queries for services, operations, and attributes. Use
NOT INto build the query. When you click into the Service or Operation field, the builder displays valid values.
When you add multiple values to the Operation field, spans that match either value (
ORoperation) are returned.
Learn more about running queries
Supported query keys
Query multiple keys and values
Once the query is run, click Create Stream.
If the button is grayed out, then a Stream already exists for that query.
To view the Stream in a tri-chart, click View Stream.
By default, the Stream takes the name of the query. You can change that to be more descriptive by clicking into the title and entering a name of your choice.
View all Streams
You can view all Streams created for your Organization from the Streams view. Click Streams from the navigation bar.
Streams are listed in alphabetical order. Use the search bar to find Streams quickly.
To view the Stream in a notebook or dashboard, click View stream.
Rename a Stream
By default, Streams are given the query parameters as the name. You can change that to be more descriptive by clicking the hamburger icon and choosing Rename.
Delete a Stream
You can delete a Stream by clicking the hamburger icon for the Stream on the list view and choosing Delete.
Deleting a Stream also deletes all historical data persisted for that Stream and can’t be undone, so be sure you want to delete it!
You can bulk delete streams by selecting them and clicking Delete selected Streams.