Logs and events

Within InsurFront, maintaining a comprehensive and transparent record of database changes is crucial for both system integrity and user oversight.

To achieve this, InsurFront employs two distinct mechanisms: Logs and Events. Both serve to record changes made to database entries, yet they function in different ways and cater to diverse needs. This article delves into the functionalities of Logs and Events.

Understanding Logs in InsurFront

The Nature of Logs

In InsurFront, navigating to the "Logs" section under the "Development" page reveals a detailed history of every change made across the platform. These logs are designed for super admins and developers, providing a comprehensive view of platform activities.

How Logs Function

• Content Recording: Logs capture the state of a database entry at the precise moment a change is made. Rather than specifying what has changed, they record the entire content of the entry.

• JSON Format: Each log entry is stored in JSON format, encompassing every field of the data type involved. This structure ensures that the data is not only complete but also organized in a universally readable and processable format.

• Use Case: The primary purpose of Logs is to offer a snapshot of database entries at any given moment. Super admins and developers can refer to these logs to understand the state of a particular entry at a specific point in time.

Events: Providing Context to Changes

Definition and Display

Events in InsurFront complement the Logs by providing a more context-specific record of changes. Displayed on the pages of most data types (such as customers, policies, quotes, leads, products, factors, etc.), Events offer an easily digestible chronicle of database alterations.

Functionality of Events

• Creation and Editing Tracking: Events are generated whenever a database entry is created or when specific fields within an entry are edited. These entries detail the nature of the edit, clearly indicating which field was altered and the content change (from/to).

• Selective Recording: Not all field changes trigger an event. The decision on which changes to record as events is based on their relevance to InsurFront users. This selective approach is guided by understanding which types of alterations hold the most significance in the platform's operational context.

• Example of Event Creation: An event is logged, for instance, when a customer's email address is updated. This level of detail is crucial for tracking critical information changes. Conversely, less impactful changes, such as a customer updating their password, may not generate an event.

The Role of Logs and Events in Development

In the broader context of InsurFront’s development and operational monitoring, Logs and Events play pivotal roles:

• Logs: Offer a detailed, time-stamped archive for developers and super admins, useful for debugging, auditing, and comprehensive data analysis.

• Events: Provide user-friendly, context-rich insights into specific data changes, enhancing transparency and traceability for everyday platform management.

Summary of events vs. logs

The dual system of Logs and Events in InsurFront represents a balanced approach to data change tracking. While Logs provide a comprehensive and detailed snapshot of data at any given point, Events offer clarity and context to the most significant changes. Together, they ensure that InsurFront remains a transparent, user-friendly, and secure platform, where data integrity and traceability are paramount. This system not only supports robust platform management but also instills confidence among users, knowing that their data interactions are meticulously recorded and easily reviewable.