Package de.tsystems.mms.apm.performancesignature.dynatrace.rest.json.api

Interface LiveSessionsApi

public interface LiveSessionsApi

Method Summary

Modifier and Type	Method	Description
retrofit2.Call<RecordingStatus>	getRecording(String profileid)	Get session recording status Check if the live session is currently being recorded.
retrofit2.Call<Void>	postRecording(String profileid, SessionRecordingOptions body)	Start session recording Start session recording for a specific System Profile.
retrofit2.Call<Void>	stopRecording(String profileid, RecordingStatus body)	Stop session recording Set recording status to false in order to stop session recording and create a reference to the stored session.
retrofit2.Call<Void>	storeSession(String profileid, SessionStoringOptions body)	Store session Store all time series and PurePaths in the Server's memory to a stored session.

Method Detail

getRecording

@GET("api/v2/profiles/{profileid}/session/recording/status")
retrofit2.Call<RecordingStatus> getRecording(@Path("profileid")
                                             String profileid)

Get session recording status Check if the live session is currently being recorded.

Parameters:

profileid - System Profile id (required)

Returns:

Call<RecordingStatus>

postRecording

@Headers("Content-Type:application/json")
@POST("api/v2/profiles/{profileid}/session/recording")
retrofit2.Call<Void> postRecording(@Path("profileid")
                                   String profileid,
                                   @Body
                                   SessionRecordingOptions body)

Start session recording Start session recording for a specific System Profile. Starting session recording is only possible for pre-production licenses.

Parameters:

profileid - System Profile id (required)

body - Session recording options (optional)

Returns:

Call<Void>

stopRecording

@Headers("Content-Type:application/json")
@PUT("api/v2/profiles/{profileid}/session/recording/status")
retrofit2.Call<Void> stopRecording(@Path("profileid")
                                   String profileid,
                                   @Body
                                   RecordingStatus body)

Stop session recording Set recording status to false in order to stop session recording and create a reference to the stored session. This call does not complete until all recorded data is fully processed on the Server. Depending on the environment, it can take a few minutes until an HTTP response message is received. Stopping session recording is only possible for pre-production licenses.

Parameters:

profileid - System Profile id (required)

body - (optional)

Returns:

Call<Void>

storeSession

@Headers("Content-Type:application/json")
@POST("api/v2/profiles/{profileid}/session/store")
retrofit2.Call<Void> storeSession(@Path("profileid")
                                  String profileid,
                                  @Body
                                  SessionStoringOptions body)

Store session Store all time series and PurePaths in the Server's memory to a stored session. To limit the data to be stored, specify a start time and end time in the request body, otherwise the last 30 minutes will be stored.

Parameters:

profileid - System Profile id (required)

body - Session storing options (optional)

Returns:

Call<Void>