How is a report created; which formats are available (HTML, PDF, XLSX)?
Short answer
A report is generated with Generate Report from the Report tab on the vService screen after a Reports profile has been assigned to the vService. In the vService Report window that opens, html, xlsx or pdf is selected as the Report Type; the html report opens interactively inside the tab, and pdf and xlsx are downloaded as files. With Send as E-mail, pdf and xlsx reports are sent by e-mail instead of being downloaded. The data of the report divisions is collected from the moment the profile is assigned, and the report is generated with all its divisions only in an HTTP vService; in L7 TCP, the report consists only of charts, and there is no report in a Network vService.
Problem: A Shareable Report on the vService Traffic Is Needed
There is a need to present to management or to a customer a report covering a specific period on the traffic, visitors, most requested pages and Backend Service distribution of a vService.
Solution
The report is generated in a single way, from the Report tab on the vService screen. For a report that arrives by e-mail at regular intervals: Can I receive reports regularly by e-mail?
Report Tab → Generate Report
- How it works For the selected date range, the report generates the division tables from the report record kept since the profile was assigned, and the charts from the Dashboard archive; the generated report is not archived.
- Where it is opened vService → Report → Generate Report
- Requirement A Reports profile assigned to the vService (the preset Default Profile is sufficient)
- vService type HTTP (only time series charts in L7 TCP; none in Network)
Step-by-Step Configuration
The profile form is opened with Load Balancer → Profiles → Reports → Add (how to add). If the preset Default Profile is to be used, steps 1–3 are skipped.
Report Profile Name is entered; Report Language, Report Divisions, Frontend Graphs and Backend Graphs are selected (profile add form).
Add in the form is clicked.
On the Load Balancer → Load Balancer vService List screen, the vService is right-clicked and Edit is selected (how to add to a vService).
In the Details panel, Report is checked; in the Report Profiles list, the preset Default Profile comes selected. If another profile is to be used, that one is selected; if more than one profile is selected, the first one becomes the main profile (more than one profile on the same vService).
Save is clicked. The data of the divisions is collected from this moment on. In a cluster setup, the change is also sent to the peer device with the default auto-sync; if Manual Sync Mode is on, it is sent manually with Synchronize.
In the Left Monitor Panel, Load Balancer vServices is selected from the category selector and the vService is clicked (accessing the screen).
In the Report tab, Generate Report is clicked (how to access). If the tab does not appear: Why can't I see the Report tab?
In the vService Report window, Report Type (default html), the Date range (the last 6 hours on first opening), Report Divisions, Frontend Graphs and Backend Graphs are selected. HTML Max. Table Rows (default 100) appears for html, PDF Graphs and PDF Max. Table Rows for pdf, and XLSX Max. Table Rows for xlsx; Report Language and Send as E-mail can also be used for pdf and xlsx. On first opening, the form comes with the values of the main Reports profile; the confirmed selections are stored per user.
Accept is clicked. The html report opens in the tab; pdf and xlsx are downloaded or sent to the Send as E-mail addresses.
Verification
The division tables in the html report are checked, or the downloaded pdf or xlsx file is opened.
The data of the selected range is filledCommon Mistakes
- Requesting a report for a period before the profile was assigned. The data of the divisions is collected from the moment the profile is assigned; the division tables for the time before that come empty.
- Expecting a division table in an L7 TCP vService. No report record is kept in L7 TCP; the document consists only of time series charts.
- Assuming the html report is stored. When another tab is opened or the page is refreshed, the html report is lost; pdf or xlsx is generated for a permanent copy.
- Not defining SMTP for Send as E-mail. For sending e-mail, E-mail Settings must be configured on the Settings → General Settings → Notification Management screen.
How it is done in the documentation
