Logging

This document describes the structure of log messages used in the application. The messages are designed for internationalization using i18next and include placeholders for dynamic data.

Each log message is composed of several key-value pairs, providing context and detail about the event being logged. The key components are:

• level: Severity of the log message.
• class: Functional area or component of the application.
• type: Type of event or status.
• object: The object the event relates to.
• reason (Optional): A specific reason for a particular type of event, especially useful for failures.
• description: Detailed message, often with placeholders for dynamic data.

The severity of the log message.

• info: Normal operation status updates.
• warning: Potential issues that may need monitoring.
• error: Unexpected errors that disrupt functionality.
• critical: Severe errors that require immediate intervention.
• alert: Urgent situation requiring immediate action.

The functional area or component of the application.

• activity: Activity History
• bsr: Bulk Search Report
• bulk_map: Bulk Map
• consolidate: Consolidation
• delete_consolidation: Delete Consolidation
• document_view: Document View
• document_view_folder: Document View Folder
• email_threading: Email Threading
• entity_deletion: Entity Deletion
• exports: Exports
• job_template: Generic Job
• ms365: Microsoft 365
• session: Session
• transcription: Audio Transcription
• user_import: Import Users
• processing: Processing

The type of event or status.

• completed: Completed
• completed_with_details: Completed with details
• completed_partially: Partially completed
• created: Created
• canceled: Canceled
• canceling: Canceling
• queued: Queued
• queueing: Queueing
• enqueued: Enqueued
• enqueuing: Enqueuing
• dequeued: Dequeued
• deleting: Deleting
• deleted: Deleted
• failed: Failed
• failing: Failing
• restored: Restored
• restoring: Restoring
• started: Started
• starting: Starting
• timed_out: Timed out
• timed_out_retrying: Timed out, retrying
• updated: Updated
• updating: Updating
• waiting: Waiting
• working: Working
• transcribing: Transcribing

The object the event relates to.

• generic: Generic
• independent: Independent
• document: Document
• job: Job

A specific reason for a particular type of event, especially useful for failures. This field provides more granular information about the event.

• timeout: Failed to complete within the allotted time frame. Contact support for retry.
• service_not_available: Job failed due to service unavailability. Contact support.

The description field contains the detailed message text. It often includes placeholders enclosed in double curly braces {{...}} for dynamic data. These placeholders are populated at runtime with actual values. The messages are designed to be used with i18next for internationalization, including pluralization using the $t() function. For example:

"description": {
  "generic": {
    "completed_import_users": "Imported $t(users, {\"count\": {{users}} })."
  }
}