Reports
The Reports resource allows you to define, schedule, and deliver recurring PDF summaries of your application’s key metrics and trends. Each report can include a variety of charts, tables, and statistics—covering requests, jobs, queries, exceptions, mails, notifications, and user activity—tailored to your needs. Once created, Laritor generates and emails each report at the intervals you specify, with data aggregated over the preceding period.
Navigation: Access Reports via the sidebar under the “Reports” section.
1. Reports Index
Section titled “1. Reports Index”On the Reports index page, each existing report is represented as a card. Cards display:
- Report Name
- Schedule (e.g., “Every Monday at 08:00”, “Daily at 02:00”)
To the right of each card, you will find icons for:
- View 🖥️ (if available)
- Edit ✏️
- Delete 🗑️
At the top-right corner, click the Create Report button to open the Report Creation form.
Tip: Organize report names clearly (for example, “Weekly Performance Snapshot” or “Daily Error Summary”) so they’re easy to identify in the index.
2. Create Report
Section titled “2. Create Report”Click Create Report to define a new PDF report. The form includes the following fields:
2.1 Report Name
Section titled “2.1 Report Name”- A descriptive title for the report (required).
2.2 Items to Include
Section titled “2.2 Items to Include”Select one or more checkboxes to include specific sections in the report. Available items:
-
Request Stats
- Total requests
- Average request duration
- Average memory usage
- Total suspicious requests
- Total bot requests
-
Requests Grouped by Request Method
- Pie chart showing request counts by HTTP method (GET, POST, etc.)
-
Requests Grouped by Status Code
- Pie chart showing request counts by status class (2xx, 3xx, 4xx, 5xx)
-
Requests Grouped by Date / Time
- Bar chart showing total requests over time intervals
-
Top Routes
- List of the top 10 routes (endpoints) with the highest request volume
-
Top Requests
- List of the top 10 request URLs with the highest visit counts
-
Fastest Requests
- List of the top 10 requests sorted by shortest duration
-
Slowest Requests
- List of the top 10 requests sorted by longest duration
-
Queue Stats
- Total queued jobs
- Average job duration
- Total failed jobs
-
Processed Jobs by Job
- Pie chart showing counts of processed jobs, grouped by job class
-
Failed Jobs by Job
- Pie chart showing counts of failed jobs, grouped by job class
-
Top Exceptions
- List of the top 10 exception classes with the most occurrences
-
Database Query Stats
- Total database queries
- Average query duration
-
Database Query Stats by Date / Time
- Line chart showing total queries over time intervals
-
Fastest Queries
- List of the top 20 fastest queries
-
Slowest Queries
- List of the top 20 slowest queries
-
Mail Stats Grouped by Mailable
- Total emails sent, grouped by mailable class
-
Notification Stats Grouped by Notification
- Total notifications sent, grouped by notification class
-
Most Active Users
- List of the top 10 users with the most activity (requests, jobs, etc.)
-
Least Active Users
- List of the bottom 10 users by activity
Tip: You do not need to include every item. Choose only those sections that are relevant to your audience or operational needs.
2.3 Schedule
Section titled “2.3 Schedule”- Select the days of the week on which the report should be delivered (at least one day, up to all seven).
- For each selected day, choose a time of day (hour and minute).
- Examples:
- “Every Monday at 08:00” (weekly, once)
- “Daily at 02:00” (all seven days at 02:00)
- “Tuesday, Thursday, Saturday at 18:30” (three times per week)
Note: The minimum frequency is once per week (one checkbox selected), and the maximum is seven times per week (all days selected).
2.4 Recipients
Section titled “2.4 Recipients”- Enter one or more email addresses (comma-separated) that should receive the PDF report.
- The report will be sent to all listed addresses each time it is generated.
Tip: Use distribution lists or group aliases if you want multiple stakeholders on the same mailing list.
2.5 Save
Section titled “2.5 Save”Click Save to create the report. After saving:
- Laritor schedules the first PDF generation according to your configuration.
- On each scheduled run, Laritor will collect data for the interval since the last report and assemble a PDF.
- The completed PDF is emailed to every address in the Recipients field.
Tip: If you select multiple items (for example, both “Request Stats” and “Top Exceptions”), the PDF will include one section per item, in the order listed above.
3. Report Lifecycle
Section titled “3. Report Lifecycle”-
Creation
- You define the report name, select items, set the schedule, and specify recipients.
-
First Run
- When the first scheduled time arrives, Laritor gathers data for the entire lookback window (e.g., if scheduled daily at 02:00, it collects data from 02:00 the day before until 02:00 today).
- A PDF is generated with all selected sections and emailed to the recipients.
-
Subsequent Runs
- On each subsequent run, Laritor collects data from the timestamp of the last run to the current scheduled time.
- For example, if the report runs weekly on Monday at 08:00, the second run includes data from the previous Monday 08:00 to the current Monday 08:00.
-
Editing or Deleting
- In the Reports index, click Edit ✏️ to adjust any settings (items, schedule, recipients). Changes take effect on the next scheduled run.
- Click Delete 🗑️ to completely remove a report. Any pending schedule for that report is canceled.
4. Best Practices
Section titled “4. Best Practices”-
Balance Frequency and Relevance
- Choose a schedule that aligns with how often you need the data. For operational dashboards, daily or hourly may be appropriate. For executive summaries, weekly or monthly is usually sufficient.
-
Limit Items to Key Metrics
- Avoid overloading a single report with too many sections. Focus on the metrics that matter most to your stakeholders to keep the PDF concise and readable.
-
Name Reports Clearly
- Use titles that reflect both content and frequency (e.g., “Daily Request Summary”, “Weekly Exception Trends”) so that recipients know exactly what to expect.
-
Validate Recipient Addresses
- Double-check email addresses before saving to avoid delivery failures. Consider using a distribution list if you need to send to a large team.
-
Review Sample Data
- After saving a report, monitor the first run’s email to confirm that all sections render correctly and that charts and tables display as expected. If adjustments are needed, click Edit to refine filters or included items.
-
Archive Old Reports
- If you no longer need a report, delete it to avoid clutter and unnecessary email traffic.
By leveraging the Reports resource, you can automate the delivery of tailored, PDF-based snapshots of your application’s health and performance—ensuring stakeholders receive exactly the data they need, on the schedule that matters.