System Logs
System Logs offers a way to view events triggered by your Amberflo account and their event object payload from inside the Amberflo console. Currently, System Logs provides visibility into webhook, alert, job, and data export events, but will be expanded to include additional events as well.
System Logs is accessible from the main navigation menu in the Amberflo console. After selecting the date range, any events that we track in your account will be shown. In the screenshot below, one data export job was completed within the selected time range, so it is the only event shown.
After selecting an event from the list view, the log will expand to include the detail view. This shows the log details and full payload. See the screenshot below for an example:
Log Event Attributes for Filtering
Amberflo allows you to filter the system logs using different combinations of attributes. In a production environment, this is necessary to quickly group and identify events. The four filtering attributes are Level, Domain, Type, and Customer.
- Level describes the severity of the event. It can have three values: INFO (for a successful event), WARN, or ERROR.
- Domain describes which of the four event categories the log belongs to. It can have four values: webhook, alert, data-export, or job.
- Type provides a more granular level of categorization within the given domain. It can have several different values depending on the domain. For example, if the domain is 'webhook' then the 'type' would detail which type of event triggered the webhook.
- Customer describes which customer the log event is associated with. Note that not all logs have an associated customer. For example, consider a weekly usage data export - there is no particular customer associated with this task. However, for other event domains such as alerts, there could be an associated customer.
Alerts, Jobs, and Data Export Events
System Logs will record an event for every alert that is triggered, providing full history of all alerts created by the system with timestamps and customer details.
Each time a data export event is attempted, a log will be created. The log will include the timestamp as well as the status (whether the job completed or failed).
System logs will also be created (using the job domain) for any long-running data request that might normally be timed out. An example of a job would be a batch usage query.
Webhook events
Amberflo will automatically create logs for five different webhook event categories. The table below contains information on the webhook events that are automatically tracked via the logging system.
Webhook name | Details |
---|---|
ready-product-invoices | Triggered when an invoice is ready to be paid |
customer-feed | Triggered when a new customer is created |
account-pricing-feed | Triggered when an account pricing object is changed (ie. pricing plan or product item list) |
customer-pricing-feed | Triggered when a customer pricing object is changed (ie. pricing plan assigned or changed for a customer) |
webhook-test | Used for testing purposes |
Log Retention
The events in the System Logs are kept for 90 days, after which they are delete.
Updated 11 months ago