User Guide

For traceability, technical support troubleshooting and legal reasons the SmartDrive keeps a persistent log of audit-able events on the systems.

An admin or SmartD qualified personal can consult these logs to diagnose problem that can arise in the field.

The logged events are the following:

• Start-up and shut-down of the system

• Start-up and shut-down of a service

• Network connection changes or failures

• Configuration change

  See new configuration and previous configuration

• Set point changes

  See new setpoint and previous setpoints

• Alarm transitions

• Changes to, or attempts to change, system security settings and controls

  Make sure firewall service start/stop is logged

  Detecting firewall rules modification

  Enabling/Disabling remote SSH access

  Enabling/Disabling remote gRPC access

• Create/Delete users

• Log-on attempts (successful or unsuccessful) and logoff

  SSH

  Console

  gRPC session start/end (include authentication failure)

• Software Update progress events

  Start/end/reboot/power interrupts

  Accept new version

  Revert to backup version

• Errors (Persistent storage)

• Boot for backup software

• Backup configuration events

• Reset metrics

  Examples: fans, start motor counter...

The event contains the following information:

• Date/Time (UTC time)

• Type of Event(see logged events list above)

• Severity:

  Use standard syslog severities (limits to INFO, WARNING, ERROR, EMERGENCY)

• Short Message describing the request and response for the request

• Origin:

  gRPC API, Mobile, WEB, HMI, I/O module, MODBUS, BLE ...

{

"time": "2022-05-09T19:08:18.000Z",

"event": "EVENT_ALARM",

"severity": "PRIORITY_INFO",

"message": "Alarm Cooling fan 2 fault has been acknowledged by user 1.",

"origin": "ORIGIN_SYSTEM"

},

{

"time": "2022-05-09T19:08:18.000Z",

"event": "EVENT_SETPOINTS_CHANGE",

"severity": "PRIORITY_INFO",

"message": "Alarm service responded to Set Setpoints request with status RESPONSE_STATUS_OK",

"origin": "ORIGIN_GRPC_API"

},

The audit log is kept in persistent storage on the SmartDrive and the drive can store up to 250,000 events (or 300MB of data).

The audit log is not affected by the restore factory settings.

The SmartDrive brownout ensures that no audit log events are lost and stored on persistent before the end of the brownout period.

Users can export the audit log in JSON format compressed and encrypted via the smartphone app.

The exported file is available and shared via the mobile app.

Go to the Clean Power VFD main menu (click on the ellipsis in the upper right corner of the Smart App screen)

select audit log

select your filter

start the download

JSON file is crreated in the app (phone)

Select share (with your usual sharing interface and function from your Ios or Android device)

Select your preferred app to share the file

and send / share