How to Snapshot Requests

Background

Snapshots

Prerequisites

1. Install the agent

2. Create a new Stoobly context

While not required, this is recommended. Otherwise the default one from your home directory will be used and will be where the snapshots get saved to. Creating a new context can be useful for storing different datasets in different code repositories and for separating snapshots.

3. Record requests

Snapshotting Requests

Command

stoobly-agent request snapshot <REQUEST-KEY>

The following page provides details on how to obtain the request's key:

Requests

For our example the request key will be p0.i4a449553b0744782809fe52d8358da78

To add the corresponding request to a snapshot, run the following command with the key like this:

$ stoobly-agent request snapshot --action PUT p0.i4a449553b0744782809fe52d8358da78

Afterwards in your data directory you'll see a new snapshots directory has been created. Here is an example of what that directory looks like:

/home/user/.stoobly/snapshots
├── log
└── requests
    └── 4a
        └── 4a449553-b074-4782-809f-e52d8358da78

Options

$ stoobly-agent request snapshot --help
Usage: stoobly-agent request snapshot [OPTIONS] REQUEST_KEY

  Snapshot a request

Options:
  --action [DELETE|PUT]  Sets snapshot action.
  -h, --help             Show this message and exit.

Snapshotting Scenarios

Command

stoobly-agent scenario snapshot <SCENARIO-KEY>

Options

$ stoobly-agent scenario snapshot --help
Usage: stoobly-agent scenario snapshot [OPTIONS] SCENARIO_KEY

  Snapshot a scenario

Options:
  --action [DELETE|PUT]  Sets snapshot action.
  -h, --help             Show this message and exit.