Datastreams

Datastreams are a flexible way to manage data ingestion. With a datastream, you may:

  • Ingest directly to a specific source dataset, instead of the shared Observation event stream.

  • Control ingest permission for a datastream through one or more revokable tokens.

  • Pause and restart ingest.

  • Rotate a token for datastream without affecting other data sources.

  • Create up to 10 datastreams per workspace.

The Datastreams tab in Workspace Settings also shows a summary of current datastreams:

Datastreams page, showing a list of streams and summary data for all streams. Observations per hour, number of streams, number of tokens, and last observation received.

Figure 1 - Datastream Summary page

Create a datastream

To use a datastream, create the datastream and then create tokens for that stream. Each datastream may have multiple tokens. They may be enabled, disabled, or deleted as needed.

Once you have created a datastream, send data to it in the same way you would configure other data sources. The sections below explain the process in more detail:

Create a new datastream

First, create a new datastream:

New datastream dialog

Figure 2 - Open a new datastream

  1. Go to Datastreams in Workspace settings and click New datastream.

  2. Provide a Name and an optional Description. A good name identifies the data you expect to ingest into this stream, as it is also the name of its dataset. Create the datastream in a package by prepending the package name. For example, “IoT/Raw device data”.

  3. Click New Datastream.

Access this stream (it’s source dataset) from the Datastreams list by clicking Open dataset on the right side of the window. You may also find it in the list of datasets on the Explore tab, or in the More section of the left menu.

List of datastreams, hover over a row to access the Open dataset button for a stream.

Figure 2 - Open the dataset for a datastream

Create a token

To send data to a stream, you need a token. A datastream token is similar to an ingest token but restricted to a specific stream. A stream can have multiple tokens, and any user with write access to the Workspace can create one.

New datastream token dialog

Figure 3 - New token for a datastream

To create a datastream token:

  1. In the Datastreams tab, click on the datastream you want to create a token for.

  2. Click New token

  3. Provide a Name and an optional Description.

  4. Click New token.

  5. Copy your new token to a safe location, check the box to confirm, and click Go to token.

Important

Be sure to save your token. You cannot view it again after closing the confirmation dialog.

Ingest data

Configure your desired data source to send to Observe, using the datastream token in place of the usual ingest token. More about sending data to Observe. Datastream observations go to the event dataset associated with the token, in the same way they would previously be in the Observation event stream. This dataset is called the datastream source dataset.

Manage datastreams and tokens

Datastreams and tokens may be enabled, disabled, or deleted. You can pause ingest from a single token or an entire stream.

Note

Only Admin and Writer members may manage datastreams and tokens.

To update a stream or token, use the dropdown at the top of the page:

datastream detail page, with Enabled/Disabled/Delete menu open

Figure 4 - Enabled/Disabled/Delete options for a datastream