The Audit Logs module empowers admin users on Ubidots to keep track of relevant actions within the platform. For example, if a device's description is changed, that action will be logged in the module, along with important context information about it, for future analysis.
Audit Logs is a great tool to:
Monitor and respond to suspicious activities.
Detect and track changes in key entities within your apps.
Ensure compliance with security and audit standards.
Requirements
An Ubidots account with an Enterprise plan.
1. How do Audit Logs work?
The Audit Logs module tracks all the actions that change any of the tracked entities (see the next chapter to learn which entities are tracked):
Creation: Whenever a new entity is created (for example, devices or dashboards), a log is generated. These actions equate to HTTP POST methods.
Update or modification: If an entity undergoes a full or partial modification, this action is recorded in the Audit Logs module. These actions equate to HTTP PUT/PATCH methods.
Deletion: Each time an entity is deleted from the platform, the action is recorded. These actions equate to HTTP DELETE methods.
2. Module features
Logs retention: Logs within the module last for 30 days.
Tracked entities: Currently, actions performed on these entities generate logs:
Dashboards
Events
Devices
Functions
Apps
3. Accessing the Audit Logs module
Go to your Ubidots account and click on you profile picture, then click on the "audit logs" option:
4. Audits Logs table
After any of the tracked entities is changed, the corresponding log will be displayed in the Audit Logs table, as shown below:
This is the information displayed in each log:
Event type: The entity and action that generated the log (separated by a dot).
Date: When the action took place.
Method: The type of HTTP method that was used to execute the action.
Host: The server's address.
Path: The resource's address.
Status: Code returned by the HTTP request.
Port: The port through which the request was performed.
5. Checking the logs
You can access each log's detailed information by clicking on either the event type or the log icon (which is in the last column of the table). Here you'll see 3 tabs:
Headers: Displays all the headers sent in the requests.
Body: Displays the body sent in the request.
Response: Displays the request's response.
The screenshot below shows the "headers" tab:
