package bosdyn.api.log_status
Get desktop application:
View/edit binary Protocol Buffers messages
The LogStatusService provides clients the ability to - Retrieve log status by id - Access a collection of active logs - Start and stop retro logs - Start, extend and stop experiment logs - Terminate logs before their expiration time
View statuses of active logs.
message
log_status.proto:90optional header = 1
Common request header.
message
log_status.proto:95optional header = 1
Common response header.
GetActiveLogStatusesResponse.Status status = 2
Response status.
repeated log_statuses = 3
A collection of the statuses of logs that are not in a terminal state (logStatus < 100)
Retrieve log status by id.
message
log_status.proto:65optional header = 1
Common request header.
string id = 2
Id of the log to retrieve.
message
log_status.proto:73optional header = 1
Common response header.
GetLogStatusResponse.Status status = 2
Response status.
optional log_status = 3
Status of the retrieved log.
Given a duration T and an event E, starts an experiment log that will include any data the robot associates with E, with a keepalive/watchdog timer of T. However, unlike an experiment log it allows for concurrency, so E must be provided to constrain the data included in the log.
message
log_status.proto:111optional header = 1
Common request header.
optional keep_alive = 2
How long into the future should this log end?
optional past_textlog_duration = 3
How long into the past should text logs extend? (default 0)
optional event = 4
Specify an event for the request. The data included in the log will be defined by this event, if the robot has data associated with the event.
message
log_status.proto:126optional header = 1
Common response header.
StartConcurrentLogResponse.Status status = 2
Response status.
optional log_status = 3
Status of the created log.
optional end_time = 4
Timestamp of the end of the log, in robot time.
Given a duration T, StartExperimentLog(T) starts logging all data to disk with a keepalive/watchdog timer of T. The duration of the log will be [t_rpc, t_rpc + T] where t_rpc = time of RPC reception. The duration of this log can be extended by calling UpdateExperimentLog before the log's status reaches a terminal state. If any retro logs are running, they will be terminated by starting an experiment log. Only one experiment log can be run at a time.
message
log_status.proto:177optional header = 1
Common request header.
optional keep_alive = 2
How long into the future should this log end?
optional past_textlog_duration = 3
How long into the past should text logs extend? (default 0)
message
log_status.proto:188optional header = 1
Common response header.
StartExperimentLogResponse.Status status = 2
Response status.
optional log_status = 3
Status of the created log.
optional end_time = 4
Timestamp of the end of the log, in robot time.
Given a duration T, StartRetroLog(T) triggers a log covering the timespan [logStartTime, t_rpc], where logStartTime = max(t_rpc - T, t_buffer), t_rpc = time of RPC reception, and t_buffer = time of first log on the buffer.
message
log_status.proto:148optional header = 1
Common request header.
optional past_duration = 2
How long into the past should this log start?
message
log_status.proto:156optional header = 1
Common response header.
StartRetroLogResponse.Status status = 2
Response status.
optional log_status = 3
Status of the created log.
optional end_time = 4
Timestamp of the end of the log, in robot time.
Terminate Log before it is complete.
message
log_status.proto:241optional header = 1
Common request header.
string id = 2
Id of log to terminate.
message
log_status.proto:249optional header = 1
Common response header.
TerminateLogResponse.Status status = 2
Response status.
optional log_status = 3
Status of terminated log.
UpdateExperimentLog(id, T) will update the keepalive/watchdog timer of the log with the provided id if the log is active. The updated duration of the log will be [t_rpc, t_rpc + T] where t_rpc = time of RPC reception.
message
log_status.proto:209optional header = 1
Common request header.
optional keep_alive = 2
How long into the future should this log continue?
string id = 3
Id of log to be extended.
message
log_status.proto:220optional header = 1
Common response header.
UpdateExperimentLogResponse.Status status = 2
Response status.
optional log_status = 3
Status of the updated log.
optional end_time = 4
Timestamp of the end of the log, in robot time.
Used in:
STATUS_UNKNOWN = 0
STATUS_OK = 1
Used in:
STATUS_UNKNOWN = 0
STATUS_OK = 1
STATUS_ID_NOT_FOUND = 2
This log is not available on the robot.
message
log_status.proto:17Used in: , , , , , ,
string id = 1
Id of the response log.
LogStatus.Status status = 2
Status of the response log.
LogStatus.Type type = 3
Type of log.
optional start_time = 4
Timestamp of the start of an experiment log, in robot time.
optional end_time = 5
Timestamp of the end of an experiment log, in robot time.
optional run_time = 6
Current duration of an experiment log, in robot time. This is not the total runtime, but rather how long it has run as of now.
string event_key = 7
Associated event, if any. Will be an empty string for retro logs.
Status of a previous request for log bundler generation. Terminal statuses start at 100, such that if a status >= DONE, it can be concluded that the request is no longer active.
Used in:
STATUS_UNKNOWN = 0
The status was not set, so something went wrong.
STATUS_RECEIVED = 1
Request received, thread is not created for bundling the logs.
STATUS_IN_PROGRESS = 2
Request in progress, thread is actively creating the bundle.
STATUS_SYNCING = 3
Log end_time has passed, server post processing taking place.
STATUS_STOPPING = 4
Log stop requested, stopping in progress.
STATUS_DONE = 100
Bundling process is complete with no failures and was terminated by API.
STATUS_FAILED = 101
Failure encountered while generating bundle.
STATUS_TERMINATED = 102
Bundle creation was terminated by API prior to completion.
Types of logs
Used in:
TYPE_UNKNOWN = 0
TYPE_EXPERIMENT = 1
A log into the future.
TYPE_RETRO = 2
A retroactive log.
TYPE_EVENT = 3
A log created automatically from an event.
TYPE_DATA = 4
A log created from a data log request.
TYPE_CONCURRENT = 5
An experiment log that allows concurrency.
Used in:
STATUS_UNKNOWN = 0
STATUS_OK = 1
STATUS_EXPERIMENT_LOG_RUNNING = 2
An experiment log is already running.
STATUS_CONCURRENCY_LIMIT_REACHED = 3
Maximum number of logs running concurrently.
STATUS_NO_DATA_FOR_EVENT = 4
The specified event has no data associated with it
Used in:
STATUS_UNKNOWN = 0
STATUS_OK = 1
STATUS_EXPERIMENT_LOG_RUNNING = 2
Cannot start another experiment log, one is already running.
Used in:
STATUS_UNKNOWN = 0
STATUS_OK = 1
STATUS_EXPERIMENT_LOG_RUNNING = 2
An experiment log is already running.
STATUS_CONCURRENCY_LIMIT_REACHED = 3
Maximum retro logs running concurrently.
Used in:
STATUS_UNKNOWN = 0
STATUS_OK = 1
STATUS_ID_NOT_FOUND = 2
This log is not available on the robot.
Used in:
STATUS_UNKNOWN = 0
STATUS_OK = 1
STATUS_ID_NOT_FOUND = 2
This log is not available on the robot
STATUS_LOG_TERMINATED = 3
Log has already terminated