Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Gumband Logs & Events

One of the most powerful features of Gumband is having access to real-time logging of low level hardware events, this can make debugging and monitoring of hardware components at runtime much easier. While it is up to the exhibit developer to determine how best to monitor their physical devices, the Gumband API provides a simple method to share and save that information. Debug logs are rate-limited to prevent spamming the server.

Excerpt
nameLog limit
Info

Logs are limited to 10 messages per second and are currently not sent to exhibits. If this rate is exceeded there is a 5 second hold-off period where no messages will be sent.

Event Logs

Log messages

Events

https://deeplocal.atlassian.net/wiki/spaces/GS/pages/3506191/Hardware+UI#%5BinlineExtension%5DRun-a-Report

Messages for reporting of exhibit events. These logs are generally reserved for events that are of interest to the exhibit owner or the exhibit maintainer (for lifetime monitoring of hardware for example). Logs such as the total number of user interactions or button presses can be sent to this endpoint. The UI can be used to pull reports or view a plot of real-time activity by day.

Developer Logs

Error Logs

Error logs are for monitoring of critical hardware or device errors and failures. Gumband can be configured to send an alert when this error is seen. Error logs are saved indefinitely.

...

Debug Logs

https://deeplocal.atlassian.net/wiki/spaces/GS/pages/3506191/Hardware+UI#%5BinlineExtension%5DView-Developer-Logs

Debug logs are typically informational messages for routine hardware events. The Gumband service automatically sends some Debug logs for events such as settings updates and reboots, but the user can add more that are relevant to their specific hardware/firmware. Debug log messages are saved for 30 days. Debug logs are also rate-limited to prevent spamming the server.

Excerpt
nameLog limit
Info

Debug Logs are limited to 20 messages every 2 seconds and are currently not sent to exhibits. If this rate is exceeded there is a 5 second hold-off period where no messages will be sent.

...

Notify

Send a notification message to the Cloud. Anyone who is subscribed to notification messages for this hardware will immediately receive an email notification with the message. Once attached to an Exhibit, you can go to the notifications tab to subscribe to hardware notifications.

...