Service: Log

This API is officially released and maintained.

The Log service provides methods to access the logs of selected software modules running on the device. Via this service, the client is able to monitor events that happen on the device during operation. This allows to asses the state of the device or to have additional information if the sensor is in a failed state.

Table 1. Available methods
Method Request Response

Stream

LogStreamRequest

LogStreamResponseStream

Stream

Is used to request a stream of log entries from the logs of the device.

Request

Stream request

Table 2. Available fields in blickfeld.diagnostics.services.LogStreamRequest
Field Type Default Unit

cursor

optional data.Log.Entry.Cursor

-

-

The cursor pointing to the log entry from which to start the stream from. This field is optional. If it is not set the stream will start from the tail of the journal.

NOTE: To be able to set this field and to specify a valid start position in the journal, first, a valid cursor needs to be received via the response to this request. Further requests can then stream relatively to the received cursor.

time_direction

optional config.Log.TimeDirection

-

-

The streaming direction is used to specify if the service should stream the log entries towards older or more recent messages: i.e. backward or forward in time. This way, the client can either continuously fetch log messages one-by-one from the most recent to the oldest or wait for the occurrence of new log entires.

Response Stream

Stream response

Table 3. Available fields in blickfeld.diagnostics.services.LogStreamResponse
Field Type Default Unit

entry

data.Log.Entry

-

-

The requested log entry.