SLA Reports and SLA Report Scheduler
One feature of the Data Archive is that SLA Reports can be generated from the collected data. The SLA Reports themselves can also be stored in the Data Archive and sent as emails.
SLA Reports can be created both manually and automatically using the SLA Report Scheduler.
Prerequisite: Create SLA Report Templates
To generate SLA Reports, you need at least two “SLA Report Templates”:
- one for Synthetic Monitoring Groups
- and one for Synthetic Monitoring Jobs.
You can copy these two SLA Report Templates from predefined Meta-Templates. Proceed as follows:
In the Data Archive click on “SLA Report Templates”, and then click on “Add SLA Report Template”:
In the “Add SLA Report Template” dialogue select SLA Report Level = Monitoring Group and click on “Copy Meta-Template”:
Select the Meta-Template for Monitoring Groups:
In the “Add SLA Report Template” dialogue click “Modify SLA Report Template”:
Your SLA Report Template for Monitoring Groups is now available:
Repeat the steps above to obtain an SLA Report Template for Monitoring Jobs: Click “Add SLA Report Template” again, select SLA Report Level = Monitoring Job and choose the appropriate Meta-Template for Monitoring Jobs.
After that, you should have two SLA Report Templates: one for Monitoring Groups and one for Monitoring Jobs:
Note: Once this step is completed, you can also clone an existing SLA Report Template and then adapt it to your needs. For example, you could change the displayed logo (image) of the SLA Report Template.
Manually Generated SLA Reports
SLA Reports can be manually generated in any time zone and in any time range. Proceed as follows:
- First, select your preferred Time Zone in the Data Archive.
- Now select the Time Range.
- Then click the “Select Time Range” button.
- Now you can click on the PDF Icons in the shown Monitoring Groups and Jobs.
Input Fields for SLA Reports at Monitoring Group Level
- SLA Target Availability : This value is taken from the Monitoring Group configuration, but you can override it here.
- Own Comment : Optionally, you can enter your own comment here, which will be displayed in the SLA Report.
- SLA Report Template : If you have created multiple SLA Report Templates for Monitoring Groups, you can select your desired template here.
- SLA Report File Name : Here you can set the middle section of the SLA Report Filename.
Input Fields for SLA Reports at Monitoring Job Level
- SLA Target Availability : This value is taken from the Monitoring Job configuration, but you can override it here.
- SLA Average Performance : This value is taken from the Monitoring Job configuration, but you can override it here.
- SLA Performance Percentile (% and ms) : This value is taken from the Monitoring Job configuration, but you can override it here.
- Own Comment : Optionally, you can enter your own comment here, which will be displayed in the SLA Report.
- SLA Report Template : If you have created multiple SLA Report Templates for Monitoring Jobs, you can select your desired template here.
- SLA Report File Name : Here you can set the middle section of the SLA Report Filename.
Downloading and Saving the Manually Generated SLA Report
The generated SLA Report is initially only displayed, but not yet saved anywhere. However, you can download it and/or save it in the Data Archive:
Saved SLA Reports: Viewing, Downloading and Emailing
In the Data Archive click on “Generated SLA Reports”.
When this dialog is opened, all saved SLA Reports are displayed in a table. You can, however, restrict the table’s contents by selecting a specific Monitoring Group or Monitoring Job. You can also filter the table contents by SLA time range.
By clicking on a PDF Icon in a table row, you can view and download a single SLA Report.
Deleting Multiple SLA Reports.
Be careful when clicking “Select All SLA Reports” in the Table Header and then deleting the SLA Reports. “Select all” means that all other SLA Reports on hidden pages of the table will also be selected. This can lead to accidentally deleting too many SLA reports.
Sending Multiple SLA Reports via Email
Multiple selected SLA Reports can be sent in a single Email by clicking the “Email Selected SLA Reports” button.
You can enter multiple email recipients, separated by semicolon. We recommend sending the email in HTML format, as it contains direct links to the PDF reports in addition to the attached ZIP file.
In addition to the PDF files of the SLA Reports, the ZIP file also contains JSON data of the SLA Reports.
Downloading Multiple SLA Reports as ZIP file
The ZIP file can be created and downloaded by clicking the “Download Selected SLA Reports as ZIP File” button. Similar to ZIP files in emails, these ZIP files also contain JSON data of the SLA reports in addition to the PDF files of the SLA reports.
SLA Report Scheduler
The SLA Report Scheduler can be used to automate the generation of SLA Reports and the sending of the reports via email.
SLA Recipient Lists
Each SLA Report Scheduler Job can have one or more SLA Recipient Lists assigned. An SLA Recipient List contains the Email Addresses to which the SLA Reports are sent.
Adding an SLA Report Scheduler Job
Input Fields for SLA Report Scheduler Jobs
- SLA Report Scheduler Job Title : You can enter any value, but the Job Title must be unique across all jobs.
- SLA Time Zone : Select the Time Zone in which the SLA Reports will be generated.
- Execution Enabled : Here you can specify whether the execution of the SLA Report Scheduler Job is enabled or disabled.
- Execution Interval : Select the periodic Execution Interval for the job. The First Day of Week is only relevant if the job is run weekly.
- Generate SLA Reports for : Here you can select for which Monitoring Groups and Monitoring Jobs the SLA Reports are generated.
- Override Configured SLA Target Availability : The applied SLA Target Availability is typically determined by the individual configuration of each Monitoring Group and Monitoring Job. This can be overridden here.
- SLA Report Template for Monitoring Groups : If you have created multiple SLA Report Templates for Monitoring Groups, you can select your desired template here.
- SLA Report Template for Monitoring Jobs : If you have created multiple SLA Report Templates for Monitoring Jobs, you can select your desired template here.
- Assigned SLA Recipients Lists : Here you can assign (or remove) the SLA Recipients Lists.
Runtime Behavior after adding an SLA Report Scheduler Job
Note 1: At the time when an SLA Report Scheduler Job is executed, it will always generate the SLA Reports for the previous day/week/month (depending on the configured Execution Interval).
Note 2: When a new, enabled SLA Report Scheduler Job is added, that job will run for the first time immediately (within next 5 minutes).
Initially, the job will be displayed as never running. You can click the Refresh Icon approximately every 30 seconds (not too often in a short period of time – otherwise you will be locked out):
Within the next 5 minutes, the job is displayed as “first time executed” and the relevant SLA Recipients have been notified by email.
In addition to the PDF files of the SLA Reports, the attached ZIP file also contains JSON data of the SLA Reports.
The newly generated SLA Reports are also stored in the Data Archive. However, if you delete them in the Data Archive, the hyperlinks in the sent emails will no longer work. The SLA reports themselves are still available in the ZIP file of the email.
Troubleshooting the SLA Report Scheduler
The SLA Report Scheduler has its own separate log, which is independent of other RealLoad components. If, unexpectedly, some or all SLA Reports were not generated, you can check the log for the reason:
Developing your own SLA Report Templates
SLA Report Templates are created as HTML Code, which is then converted into a PDF Document. The HTML Code contains placeholders in the format ${<placeholder-name>}. This means that actual SLA values (or a combination of multiple SLA values) are used instead of the placeholders. Additionally, images and external files referenced by HTML (such as a style sheet) can be uploaded to the template and referenced as placeholders in the HTML Code.
Please note that there are two types of SLA Report Templates:
- Templates for Monitoring Groups, and
- Templates for Monitoring Jobs
Some placeholders are identical for both Monitoring Groups and Jobs, but other placeholders apply only to Monitoring Groups or Monitoring Jobs.
It is not recommended to develop SLA Report Templates from scratch. Instead, you should first clone an existing template and then modify that clone:
Set a new, unique “SLA Template Title” for the clone:
And now modify the newly generated SLA Report Template:
Example: Replacing the Company Logo and Company Name
First, delete the existing company logo in the SLA Report Template and then upload your own company logo:
Now enlarge the area of the HTML editor and locate the point in the HTML code where the company logo is referenced:
In this example, the reference to the company logo and the company name is located in line 17 of the HTML code:
<div style="float: right; text-align: center;"><img src="data:image/jpeg;base64,${imageB64_1}" style="width: 80px; height: auto;"><br><small>Generated by<br>RealLoad</small></div>
If your uploaded company logo is a different image type than “image/jpeg”, you must replace it here (for example with “image/gif”).
After that, you can test the modified SLA Report Template for the first time:
As you can see in this example, the company logo is displayed somewhat small and the company name has not yet been changed:
Increase the size of the company logo image in the HTML code and replace the company name in the HTML code:
<div style="float: right; text-align: center;"><img src="data:image/jpeg;base64,${imageB64_1}" style="width: 110px; height: auto;"><br><small>Generated for<br>Acme Corporation</small></div>
Then it looks like this:
Important: Don’t forget to save the template:
