Snapshots

Tailpipe enables you to take snapshots. A snapshot is a saved view of a benchmark run or dashboard that you can view as a dashboard in Powerpipe All data and metadata for a snapshot is contained in a JSON file which can be saved and viewed locally in the Powerpipe dashboard or uploaded to Turbot Pipes. Snapshots in Turbot Pipes may be shared with other Turbot Pipes users or made public (shared with anyone that has the link).

You can create Turbot Pipes snapshots directly from the Powerpipe CLI, however if you wish to subsequently modify them (add/remove tags, change visibility) or delete them, you must do so from the Turbot Pipes console. You may browse the snapshot list in Turbot Pipes by clicking the Snapshots button on the top of your workspace's Dashboards page.

Taking Snapshots

To upload snapshots to Turbot Pipes, you must either log in via the powerpipe login command or create an API token and pass it via the --pipes-token flag or PIPES_TOKEN environment variable.

To take a snapshot and save it to Turbot Pipes, simply add the --snapshot flag to your command.

The --snapshot flag will create a snapshot with workspace visibility in your user workspace. A snapshot with workspace visibility is visible only to users that have access to the workspace in which the snapshot resides -- A user must be authenticated to Turbot Pipes with permissions on the workspace.

If you want to create a snapshot that can be shared with anyone, use the --share flag instead. This will create the snapshot with anyone_with_link visibility:

You can set a snapshot title in Turbot Pipes with the --snapshot-title argument.

If you wish to save to the snapshot to a different workspace, such as an org workspace, you can use the --snapshot-location argument with --share or --snapshot:

Tagging Snapshots

You may want to tag your snapshots to make it easier to organize them. You can use the --snapshot-tag argument to add a tag:

Simply repeat the flag to add more than one tag:

Saving Snapshots to Local Files

Turbot Pipes makes it easy to save and share your snapshots, however it is not strictly required; You can save and view snapshots using only the CLI.

You can specify a local path in the --snapshot-location argument or TAILPIPE_SNAPSHOT_LOCATION environment variable to save your snapshots to a directory in your filesystem:

You can also set snapshot_location in a workspace if you wish to make it the default location.