Skip to main content

Create Log Message

Description​

Creates log message via the web service.

Function Signature:​

def create_log_message(log_config: LogConfig, message: str, log_to_console: bool = True) -> LogMessageResult:

Parameters​

  • log_config (LogConfig): Configuration for logging to the web service.
  • message (str): Input value for message.
  • log_to_console (bool): Input value for log_to_console.

Returns​

  • LogMessageResult: A result object containing:
    • code: HTTP status code (200 for success, -1 for exceptions).
    • description: Response body or error message.
    • log_message: Parsed response data when available.

Example Usage​

# Example usage
log_config = LogConfig(ws_config, device_serial, agent_type, agent_version, agent_index, process_id)
message = "example"
log_to_console = False
result = create_log_message(log_config, message, log_to_console)
print(result)

Behavior​

  • Sends a signed request to the web service.
  • On success (code 200), response data is parsed into the result object.
  • On success, returns the computed value or result object.

Error Handling​

  • Exceptions set the result code to -1 and include an error message when implemented.