Live sessions (REST)

As described in Usage of Sessions, there are two different approaches creating a stored PurePath session. If you use the Store Session request, all PurePaths of the current live session are dumped to a stored PurePath session.

You can also record all incoming PurePaths by issuing Start Recording and Stop Recording requests.

The AppMon Server offers several RESTful interfaces for these operations.

Start session recording

The POST request triggers session recording for the specified System Profile.

Note

Request only works in pre-production edition.

The request consumes application/json.

POST
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/session/recording
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/session/recording
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/session/recording

Get session recording status

Checks whether the specified System Profile records a session.

The request produces application/json.

GET
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/session/recording/status
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/session/recording/status
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/session/recording/status

Stop session recording

The PUT request stops session recording for the specified System Profile. It's doing so by setting recording status as 'false'. It also creates a reference to the stored session.

Note

Request only works in pre-production edition.

Note

This call does not complete until all recorded data is fully processed on the Server.

The request consumes application/json.

PUT
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/session/recording/status
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/session/recording/status
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/session/recording/status

Store session

The POST request triggers storage of all time series and PurePaths to a stored session.

You need to limit the data to be stored, by specifying a start and end times in the request body. Otherwise the last 30 minutes will be stored.

The request consumes application/json.

POST
  • AppMon 2017 May https://{server}:8021/api/v2/profiles/{profileID}/session/store
  • AppMon 2018 April https://{server}:8021/api/v3/profiles/{profileID}/session/store
  • AppMon 2018 October https://{server}:8021/api/v4/profiles/{profileID}/session/store