Skip to main content

Logs and Events

Logs

Logs are available under System -> Logs. this is a UI of stdout for the containers & kernel logs.

logs-list

Logs can also be found on the spr host by running docker compose logs in the super directory.

Events

events-list

In addition to API logs, evetns include device actions ando ther activity. Examples: when a device connects, a dns lookup is made or traffic is routed. See the sprbus service for more information about available events.

Notifications

NOTE: Notifications are deprecated and have been replaced by Alerts which support notifications.

Notifications can be set for certain events. Example: a device connects to a specific IP address.

notification-list See the nft: -prefix events from sprbus documentation for more information.

Enable notifications

notification-add

Navigate to Events -> Notifications click Add Notification.

Select prefix (direction of traffic), protocol and address information. If the notification is enabled, when triggered, a popup will appear in the ui (or notification on iOS app).

Using the cli tools

View main logs for spr containers with docker compose logs -f in super directory.

Packet logs

Retrieve JSON packet logs with

docker exec -it superpacket_logs /stream-json-logs

Events

The sprbus tool can be used to view logs and events. Either run it locally or connect with an API token.

You can generate an API token in the UI under "Auth-> Add Auth Token"

export TOKEN="SPR-API-TOKEN"
./sprbus --addr 192.168.2.1

sprbus