PRTG SLA Plugin · 1 PRTG NETWORK MONITOR 1.1 Enjoy High Availability with PRTG Availability...
Transcript of PRTG SLA Plugin · 1 PRTG NETWORK MONITOR 1.1 Enjoy High Availability with PRTG Availability...
PRTG SLA PLUGIN USER MANUAL
CORP-IT 6/23/2020
Abstract The purpose of this document is to describe the prerequisites, to configure and to use the
PRTG SLA Plugin application.
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 2 of 31
TABLE OF CONTENTS
1 INTRODUCTION TO PRTG SLA PLUGIN ............................................................................................... 5
1.1 APPLICATION CONFIGURE .................................................................................................................... 6
1.1.1 Application Best Practices ............................................................................................................. 6
1.1.2 Application requirements ............................................................................................................... 6
1.1.3 Application Install .......................................................................................................................... 7
1.1.4 Define user .................................................................................................................................... 8
1.1.5 Define PRTG connection .............................................................................................................. 8
1.1.6 Configure general settings .......................................................................................................... 10
1.1.7 Define the SMTP mail address settings ...................................................................................... 11
2 WORKING WITH PRTG SLA PLUGIN .................................................................................................. 13
2.1 GENERAL GRAPHICAL USER INTERFACE FEATURES ............................................................................ 13
2.1.1 Sorting and filtering ..................................................................................................................... 13
2.2 DASHBOARD ...................................................................................................................................... 13
2.3 FILTERS ............................................................................................................................................ 15
2.4 SERVICE LEVEL AGREEMENTS ........................................................................................................... 17
2.4.1 Adding SLA’s ............................................................................................................................... 17
2.4.2 SLA Options Menu ...................................................................................................................... 20
2.5 SCHEDULES ...................................................................................................................................... 20
2.6 PLANNED DOWNTIMES ....................................................................................................................... 22
2.7 REPORTS .......................................................................................................................................... 23
2.7.1 Report Details .............................................................................................................................. 26
2.8 SCHEDULED REPORTS ....................................................................................................................... 28
2.9 SETTINGS ......................................................................................................................................... 29
2.10 USERS .............................................................................................................................................. 30
2.10.1 User roles ................................................................................................................................ 30
2.10.2 Users ....................................................................................................................................... 30
2.10.3 Create new user ...................................................................................................................... 30
2.10.4 Modify users ............................................................................................................................ 31
2.10.5 User groups ............................................................................................................................. 31
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 3 of 31
TABLE OF FIGURES
FIGURE 1 - PRTG SLA PLUGIN ............................................................................................................................ 5
FIGURE 2 - PRTG DATE FORMAT ......................................................................................................................... 6
FIGURE 3 - PREREQUISITES PAGE ........................................................................................................................ 7
FIGURE 4 - CONFIGURE SQL SERVER CONNECTION ............................................................................................. 7
FIGURE 5 - USER CREATION................................................................................................................................. 8
FIGURE 6 - ADD PRTG SERVER ........................................................................................................................... 8
FIGURE 7 - PRTG SERVER SETTINGS .................................................................................................................. 9
FIGURE 8 – PASSHASH ...................................................................................................................................... 10
FIGURE 9 - GENERAL SETTINGS ......................................................................................................................... 10
FIGURE 10 - MAILING CONFIGURATION ................................................................................................................ 11
FIGURE 11 - SPECIFY TEST EMAIL ADDRESS ........................................................................................................ 12
FIGURE 12 - SEND TEST EMAIL CONFIRMATION .................................................................................................. 12
FIGURE 13 - QUICK FILTER ................................................................................................................................. 13
FIGURE 14 - ADVANCE FILTERING BUTTON .......................................................................................................... 13
FIGURE 15 - SLA PLUGIN DASHBOARD ............................................................................................................... 14
FIGURE 16 - DASHBOARD LIST VIEW .................................................................................................................. 14
FIGURE 17 - FILTERS PAGE ................................................................................................................................ 15
FIGURE 18 - ADD FILTER .................................................................................................................................... 15
FIGURE 19 - SELECT PRTG SERVER .................................................................................................................. 15
FIGURE 20 - FILTER BY TAG ............................................................................................................................... 16
FIGURE 21 - SELECTION OVERVIEW ................................................................................................................... 16
FIGURE 22 - ASSIGNED SENSORS ...................................................................................................................... 17
FIGURE 23 - SERVICE LEVEL AGREEMENTS ........................................................................................................ 17
FIGURE 24 - ADD SLA BUTTON .......................................................................................................................... 17
FIGURE 25 - CONFIGURE NEW SLA .................................................................................................................... 18
FIGURE 26 - SET SLA TIMETABLE ...................................................................................................................... 19
FIGURE 27 - ASSIGN FILTERS ............................................................................................................................. 19
FIGURE 28 - SLA OPTIONS MENU ...................................................................................................................... 20
FIGURE 29 – SCHEDULES PAGE ......................................................................................................................... 20
FIGURE 30 - ADD SCHEDULE .............................................................................................................................. 21
FIGURE 31 - ADD EXCEPTION DAYS.................................................................................................................... 21
FIGURE 32 - SCHEDULE EXCEPTION DAYS ........................................................................................................... 22
FIGURE 33 - PLANNED DOWNTIMES .................................................................................................................... 22
FIGURE 34 - ADD PLANNED DOWNTIME ............................................................................................................... 23
FIGURE 35 - MONTHLY SERVICE LEVEL AGREEMENTS REPORT PAGE .................................................................. 23
FIGURE 36 - START PRTG POLLING TASK .......................................................................................................... 24
FIGURE 37 - GENERATING REPORTS .................................................................................................................. 24
FIGURE 38 - SERVICE LEVEL AGREEMENT REPORT - CHANGE YEAR .................................................................... 24
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 4 of 31
FIGURE 39 - EXPORT PDF BY MONTH ................................................................................................................ 24
FIGURE 40 - EXPORT PDF BY COMPANY ............................................................................................................ 24
FIGURE 41 - EXPORT PDF BY SLA ..................................................................................................................... 25
FIGURE 42 - REPORT DETAILS BUTTON .............................................................................................................. 25
FIGURE 43 - SLA DETAILS ................................................................................................................................. 25
FIGURE 44 - REPORTS FILTER ............................................................................................................................ 25
FIGURE 45 - FILTER INTERVAL ............................................................................................................................ 26
FIGURE 46 - REPORT DETAILS ........................................................................................................................... 26
FIGURE 47 - SELECT REPORT MONTH ................................................................................................................ 27
FIGURE 48 - SENSOR DOWNTIME ....................................................................................................................... 27
FIGURE 49 - SENSOR DOWNTIME DETAILS .......................................................................................................... 27
FIGURE 50 - VIEW DOWNTIMES .......................................................................................................................... 27
FIGURE 51 - DOWNTIME OPTIONS MENU ............................................................................................................ 28
FIGURE 52 - ADD SCHEDULED REPORT BUTTON ................................................................................................. 28
FIGURE 53 - ADD SCHEDULED REPORT .............................................................................................................. 29
FIGURE 54 - USER PANEL .................................................................................................................................. 29
FIGURE 55 - SETTINGS MENU ............................................................................................................................ 30
FIGURE 56 - ADD USER ...................................................................................................................................... 31
FIGURE 57 - MODIFY USER MENU ...................................................................................................................... 31
FIGURE 58 - CHANGE PASSWORD ...................................................................................................................... 31
FIGURE 59 - ADD USER GROUP ......................................................................................................................... 31
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 5 of 31
1 INTRODUCTION TO PRTG SLA PLUGIN
PRTG SLA Plugin can help meet your SLAs by monitoring the availability of your mission critical
PRTG devices and ensure you derive higher business value through better management of IT and
IT processes.
Figure 1 - PRTG SLA Plugin
By installing the PRTG SLA Plugin you will benefit of the following:
• Monitoring SLA based on values from PRTG Network Monitor
• Gives you better visibility on whether you are meeting the needs of your customers
• Downtimes granular (up to minute) reports, with user root cause analyze reasons of the
downtimes
• Flexible GUI to create your preferred SLA monitoring intervals
PRTG SLA Plugin offers the possibility to monitor and generate reports for the availability and uptime
(percentage of the time services are available) of a service making sure that the Service Level
Agreements levels are respected.
The reports can be scheduled to be sent automatically over email to a distribution list, monthly.
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 6 of 31
1.1 Application Configure
After successfully installed the PRTG SLA Plugin the application configuration wizard is
automatically started. The wizard allows the user to initialize the application by defining the needed
configuration.
1.1.1 Application Best Practices
The following recommendations, although not critical, should be followed to avoid any issues.
1. Ensure that both PRTG and the Server where the SLA Plugin is installed, are using the same
time zone.
2. Create a new user in PRTG that will be used only for the SLA Plugin.
1.1.2 Application requirements
For the application to work properly, please ensure that the following requirements are met:
1. 64-bit Windows OS (Windows Server 2012 or newer)
2. SQL Server 2012 or newer (only needed if you are using your dedicated SQL Server; not
needed if you install SQL Express using the SLA Plugin installer)
3. .NET Framework 4.7 or newer must be installed on the system that will run the application.
4. Date Format in PRTG must be set to one of the following:
- DD.MM.YYYY HH:MM:SS (24h)
- DD.MM.YYYY HH:MM:SS (AM/PM)
- MM/DD/YYYY HH:MM:SS (24h)
- MM/DD/YYYY HH:MM:SS (AM/PM)
This setting is available in PRTG, under:
Setup => Account Settings => My Account => Web Interface => Date Format
Figure 2 - PRTG Date Format
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 7 of 31
1.1.3 Application Install
After starting the installation of the PRTG SLA
Plugin, it will check to make sure that the necessary
prerequisites are installed, such as .NET
Framework and SQL Server:
From this menu, you can check all the necessary
prerequisites that need to be installed alongside the
SLA Plugin. If you plan on using an already
configured SQL Server on a different machine, you
can uncheck it from the list and specify the existing
SQL Server later on.
If you choose to install SQL Server Express from
this menu, it will automatically download and install
it before continuing with the SLA Plugin installation.
After it finishes installing SQL Server Express, the
installer will continue with the EULA and the
Configure SQL Server Connection page. From
this page, you can either select the SQL Server
Express instance that you previously created or
specify an existing SQL Server from a different
machine, as well as the Credentials need to
connect to the SQL Server. If you are using the
Express edition that the SLA Plugin installer
automatically downloaded, you can leave Trusted
Connection checked and select Install.
Once the installation is complete, it will show you a confirmation message and after selecting Finish,
it will close the window and open the SLA Plugin Configure page in your default browser.
Figure 3 - Prerequisites Page
Figure 4 - Configure SQL Server Connection
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 8 of 31
1.1.4 Define user
The first step of the configuration wizard is the creation of a user which will be later used to connect
to the application.
When creating the user, you will need to provide the following information:
• Username
• Email address
• First name / Last name
• Password
1.1.5 Define PRTG connection
To show monitoring data of your PRTG setup, the PRTG SLA Plugin must be able to establish a
connection to your PRTG web servers. For this purpose, please ensure that the following settings
are correct:
1. Select the Add option to add a new server. Depending on your license, you can add multiple
PRTG servers.
Figure 6 - Add PRTG Server
Figure 5 - User Creation
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 9 of 31
2. Specify the server details.
Alias Alias used for the PRTG Server
Protocol Choose between HTTP and HTTPS, depending on your PRTG configuration
URL IP address or DNS Name for PRTG's Web Server
Port TCP Port for PRTG's Web Server on the Web Server tab
Login Name PRTG Username
Password PRTG Password
PRTG switches to port 8080 as a fallback after a restart when port 80 is already used, and to port 8443 if
port 443 is not available. PRTG keeps the SSL connection in this case. If this port is also not available,
PRTG tries from port 32000 on until it finds an available port. Because the EC cannot recognize these ports
(8080, 8443, 32000+) automatically, enter the currently used port manually here in the Port setting. If you do
not get a connection to the PRTG web server, check the currently used port in the Web Server settings
under System Administration—User Interface in the PRTG web interface.
After filling the required information, also make sure that:
• No local software firewall blocks the connection.
• No local virus protection program blocks the connection.
• The specified port is not used by another application.
• No (hardware) firewall blocks the connection when connecting through a network (LAN or
WAN).
Figure 7 - PRTG Server Settings
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 10 of 31
* When connecting to the “Hosted by Paessler” version of PRTG, you will need to check the
passhash box and provide the passhash in the password field.
The passhash can be obtained from PRTG, from Setup -> Account Settings:
Figure 8 – Passhash
After submitting the server details, it will automatically download the PRTG Structure.
1.1.6 Configure general settings
The step allows you to define the general settings of the application.
• Attachment path: A disk location which will be used to store the generated PDF reports.
These PDF reports will then be sent via email.
• Log Path: A disk location which will be used to store the application error logs.
Figure 9 - General Settings
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 11 of 31
• Report File Name: Specify the PDF report file name which will be used when generating the
PDF reports. Two wildcards can be used in this case:
o {month} – will be replaced with the month number for which the report is generated.
o {year} - will be replaced with the year for which the report is generated.
• Company logo: An image can be uploaded to be used in the PDF reports header.
• Unknown after downtime is downtime: Select whether unknown periods after downtime
should be considered downtime as well.
1.1.7 Define the SMTP mail address settings
This step allows the configuration of a mailing server so that the application will be able to send
emails. You can also skip this step if you do not wish to setup the mailing system.
Figure 10 - Mailing configuration
PRTG SLA Plugin Introduction to PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 12 of 31
When configuring the SMTP mail address settings, you will need to specify the following:
• Account name: Alias for the account.
• Profile name: Alias for the profile.
• Mail address: the SMTP used for sending emails (e.g.: [email protected]).
• Reply to address: the email address which is used to answer to when somebody hits “reply”
to the email received from the PRTG SLA Plugin application.
• Display name: Name which will be displayed by the receivers. (e.g.: PRTG SLA Plugin)
• Mail server name: The SMTP address used to send emails (e.g.: smtp.itps-ag.ch)
• Port: The port on which the SMTP address works (typically is port 25)
• Username: The username which is used to access the SMTP server. Usually it is the same
as the “Mail address”
• Password: The password used for accessing the SMTP server.
• SSL: Select Yes if the SMTP server requires secure connection.
After specifying the necessary details, you can
send a test email in order to test the mailing
functionality.
After pressing the Send test email button, a new
window will appear, asking you for the email
address, where the test email will be sent:
After pressing the Submit button, a confirmation
message should be displayed after the button is
pressed:
Figure 11 - Specify test email address
Figure 12 - SEND test email confirmation
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 13 of 31
2 WORKING WITH PRTG SLA PLUGIN
2.1 General Graphical User Interface Features
2.1.1 Sorting and filtering
2.1.1.1 Sort
The sort functionality is available on all pages, by pressing the column header which needs to be
sorted. By pressing the same column header again, the sort order will be reversed.
2.1.1.2 Filter
All pages offer two main filter functionalities:
1) Quick filter: Allows real time filtering, by specifying any input, which will be searched on all
available columns from the specific page. If any of the columns contain the value from the
input, the whole row will be shown as a result.
2) Advanced filter: The advanced filtering functionality can be
triggered by the “Show filter” button, which is present on the
footer of all pages.
2.2 Dashboard
This is the default page that appears when opening the SLA Plugin, where you can find a brief
summary of the License, as well as the SLA and Sensors breaches, as well as a graph, representing
the number of outages month by month and day by day.
Figure 13 - Quick filter
Figure 14 - Advance filtering button
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 14 of 31
From this page, you can quickly navigate to the SLA details for each individual month by clicking
inside the charts.
You can view the Breached SLA’s and
Sensors either in a chart view (by
default) or in a list view, by selecting
the View list option.
Figure 15 - SLA Plugin Dashboard
Figure 16 - Dashboard List View
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 15 of 31
2.3 Filters
Using the Filters page, you can create lists of sensors that will be monitored. These lists can, then,
be assigned to one or more SLA’s.
To create a new filter, you need to select the Add option
If you are using multiple PRTG Servers, the correct Server will first
need to be selected from the top of this.
Figure 18 - Add Filter
Figure 19 - Select PRTG Server
Figure 17 - Filters Page
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 16 of 31
You can filter the sensors either by tags or
by name.
When filtering by tags, you can select all the
required sensors by selecting the Server,
Group or the entire Tree.
After creating a filter based on a tag, any
new sensor that will be created in PRTG
with the same tag and under the group
that you selected, will be automatically
included in the SLA.
After including the sensors, you will need to select the
Submit option, where you will be prompted to enter a
name for the filter and review the sensor selection
Figure 20 - Filter by Tag
Figure 21 - Selection Overview
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 17 of 31
Your Assigned sensors will now show up on the
right-hand side of the page. From this section, you can
also delete any sensors that you no longer want to be
included in the report, by using the Delete option:
2.4 Service Level Agreements
On this page, you can see the SLAs and can perform actions like add, edit, delete, set as inactive
and set company.
2.4.1 Adding SLA’s
When adding a new SLA, you first need to select the Add option from
the upper right corner of the page:
On the Configure SLA page, you will need to specify the following:
• Name: Specify the service level agreement name, which will be later used in the graphical
user interface and in the PDF reports to identify the service level agreement (e.g. Inside
Business Hours [MO – FR])
Figure 24 - Add SLA Button
Figure 23 - Service Level Agreements
Figure 22 - Assigned Sensors
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 18 of 31
• Company: Setting the company to an SLA will allow you to group the reports based on this
value. From this menu, you can also add a new Company by first typing the desired
company name and then selecting the Add option.
• Description: Here, you can specify any necessary details regarding this SAL.
• Start date and End date: these values are used to define when and SLA starts and when it
ends. Leave the End date empty if there is no finish date.
• Minimum / day, Minimum / month, Minimum / year: represents the minimum percentage
for each time frame (day, month, year). Any value below this will mark the SLA as “breached”.
• Expected / day, Expected / month, Expected / year: represents the expected percentage
for each time frame. Usually, the expected percentage should be greater than the minimum
percentage configure for the same time frame (day, month, year)
• Expected monthly (yearly) breach limit: It is the threshold, which when reached the SLA
is marked as breached, even if the minimum percentage was not reached.
Figure 25 - Configure New SLA
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 19 of 31
Example
We have the following SLA:
Minimum / month = 95%
Expected / day = 98%
Expected monthly breach limit = 3
If the PRTG SLA Plugin detects more than 2 values below the expected / day (98%), the SLA will be marked
as breached for given month, even if the average percentage of availability is 98% (greater than the 95%,
which is the minimum percentage configured).
After all the information has been filled in
and the Next option has been selected,
the Set SLA timetable page will appear.
Here, you will need to select all the days
(and complete the hours inputs) for which
the configured SLA will be active.
The final step is selecting the Filter, in
order for the SLA to apply to the
configured sensors.
If there is no are no filters created, you
can submit without selecting any.
You can, then, go to the Filters page to
create a new one, and then assign it to
the SLA via the Configure option in the
SLA menu.
Figure 26 - Set SLA Timetable
Figure 27 - Assign Filters
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 20 of 31
2.4.2 SLA Options Menu
After an SLA is created, you can modify it by selecting one of the following options in the menu:
- Edit: Editing will take you through the same steps as
adding a new SLA, but with the current information from
the existing SLA
- Delete: This option will completely remove the SLA and
all the data associated with it, including the reports. You
can also delete multiple SLA’s by checking the boxes next
to them and selecting Delete at the top of the page.
- Set as inactive: This will keep the all the SLA data,
including already created reports, but will not be updated
in future reports.
- Configure: From this page, you can assign filters, as well
as add new filters and edit the SLA.
2.5 Schedules
The Schedule page allows you to create schedules that can be used either to configure a
maintenance period or to schedule reports (see 3.8 Scheduled reports). In the bellow image,
you can see a schedule defined for Christmas. This means that during that period the downtime will
be considered planned.
Figure 29 – Schedules Page
Figure 28 - SLA Options Menu
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 21 of 31
In order to add a schedule, you need to select Add in the upper right corner of the page.
Here, you will need to specify the following:
- Schedule Name
- One time/Recurring: The recurring ones can be daily, weekly or monthly.
- Start date/time
- End date/time
The Description field will be automatically populated with the details that you provide above.
The schedules can contain exception days which can be defined
by selecting Exception days in the schedule options menu.
Figure 30 - Add Schedule
Figure 31 - Add Exception Days
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 22 of 31
In the bellow example, we can see the calendar that appears. Here you can define the days on
which you don’t want the schedule to run. These days will be ignored by the schedule and downtimes
will not be set as planned.
2.6 Planned downtimes
The planned downtimes page allows you to configure the maintenance period of a device or
sensor.
Figure 33 - Planned downtimes
By selecting ADD button, from the upper right corner of the page, you can configure the maintenance
period of a device.
Figure 32 - Schedule exception days
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 23 of 31
Figure 34 - Add planned downtime
When adding a planned downtime, you will need to specify the Sensor and Schedule.
Optionally, you can provide a Ticket number and a Comment for the planned downtime.
2.7 Reports
The Reports page grants you access to the monthly overview of the Service Level Agreements
After creating the SLA’s, the reports page will be blank, as it starts generating the first reports at a
specific hour and will generate every one hour after that.
Figure 35 - Monthly Service Level Agreements Report Page
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 24 of 31
You can manually generate the reports by selecting the Start PRTG Polling Task option next to
your username, in the upper right corner of the page.
You can switch between years by clicking on the dropdown menu in the upper right corner of the
page and simply change the year for which you want to see the report.
Also, the reports are grouped based on a company (which you can assign to an SLA as seen in the
service level agreement chapter). You can expand and collapse each Company section for easier
navigation on the page, by clicking on the Company bar itself.
Each SLA is represented in a container which can have two colors:
• RED
o If the unplanned downtime is higher than the “minimum downtime” per month defined
in the SLA agreement;
o If the unplanned downtime is below the “expected downtime” defined in the SLA more
than the “expected downtime breach limit” times.
• GREEN otherwise.
There is also the option to export to PDF on three levels:
• Month level, where all the SLAs from that month will be exported to PDF:
Figure 39 - Export PDF by Month
• Company level, where all the SLAs that are part of a company will be exported to PDF:
Figure 40 - Export PDF by Company
Figure 36 - Start PRTG Polling Task Figure 37 - Generating Reports
Figure 38 - Service Level Agreement Report - Change Year
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 25 of 31
• Service Level Agreement level, where the selected SLA will be exported to PDF:
Figure 41 - Export PDF by SLA
In order to see the detailed report for an SLA, simply click on the Go to details button you will be
redirected to the SLA report details page:
Figure 42 - Report Details Button
For each individual SLA, you can also see the following details:
- Total outages – Total number of
outages
- Total outage time – Cumulated
time for the total number of outages
- Mean time between failures
(MTBF) – Average uptime between
two downtime occurrences for the
given SLA.
- Mean time to repair (MTTR) –
Average amount of time for a
downtime occurrence for the given SLA.
You can also filter the report data, by opening the Filter Menu, form the magnifying glass icon, in
the upper-right corner of the page:
From this filter menu, you can select specific periods of time, for which to view the data:
Figure 43 - SLA Details
Figure 44 - Reports Filter
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 26 of 31
2.7.1 Report Details
When accessing a Service Level Agreement report details you will have access to information of all
devices and sensors which are part of the selected Service Level Agreement.
The Report details page shows detailed information on the currently selected Service Level
Agreement, Month and Year and its devices and sensors:
Figure 45 - Filter Interval
Figure 46 - Report Details
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 27 of 31
The Details page for each SLA offers fast navigation between different months. The navigation
options can be found on the top part of the page.
The devices that have downtime, can be expanded to see extra information.
Figure 48 - Sensor Downtime
You can expand any sensor to see more details:
Figure 49 - Sensor Downtime Details
By expanding the sensors, you will be able to spot all the downtimes available in the monitored SLA
time interval.
This page offers you the possibility to manage the downtimes of a sensor, by marking an “unplanned”
or “unknown” interval as a “planned downtime”.
This can be achieved by clicking on the “View
downtimes” button.
Figure 50 - View Downtimes
Figure 47 - Select Report Month
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 28 of 31
In the Sensor downtimes page, for each
downtime period, you will have the possibility
to make the following changes by opening
the downtime options menu:
- Set ticket number and comment
- Set as planned
- Set as unplanned
2.8 Scheduled reports
From the Scheduled reports page, you can generate reports for custom intervals and send them out
to specific email address.
To create a new scheduled report, you need to select Add from the upper right corner of the page:
Figure 52 - Add Scheduled Report Button
You will need to provide the following information in order to create the scheduled report:
- Schedule Name: The name of the new report.
- Email: The email address/addresses separated by comma. If you leave this box empty, it
will not send out any emails.
- Schedule: You will need to select a previously created schedule.
- Agreements: You can select one or more SLA’s for which to generate the report. If you leave
the box empty, it will generate reports for all SLA’s.
- Period: The period for which to generate the report. It can be Current or Previous
- Period type: You can select one of the following period types:
• Day: Generate a report for each day.
• Week: Generate a report for each week. The first day of the week can be set as desired.
Figure 51 - Downtime Options Menu
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 29 of 31
• Month: Generate a report for each month. The first day in the report can be set to any
day in the month (ex: from the 5th of the month to the 4th of next month).
• Quarter: Generate a report for each quarter.
• Year: Generate a report for each year. It can be set to start at the beginning of the year
(01.01 -31.12) or in the middle of the year (01.07 – 30.06).
Figure 53 - Add Scheduled Report
2.9 Settings
The settings functionality can be accessed from the top-left
corner, by clicking on the name.
This allows the user to change all application settings, that were
initially configured in the installation.
Figure 54 - User Panel
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 30 of 31
The settings menu contains the following 5 sections:
1) Change password: Used to change the password for the
currently logged in user.
2) General: Offers the possibility to change the attachment path,
company logo, log path and Report File Name.
3) PRTG Servers: Add, Remove, Edit the PRTG Servers or Sync
the PRTG Structure.
4) Security: Add, Remove, Edit the Users and User groups.
5) Mailing: Allows the modification of the mailing settings from
where the emails are sent.
2.10 Users
2.10.1 User roles
The application supports 3 main user roles, with different access levels
1) Administrator – which has full access to the entire application (settings, planned
downtime, reports, configure monitoring, users, mailing)
2) Reporting – has access only to the Reports page but can mark any “unplanned” or
“unknown” intervals as “planned” downtime.
3) Reporting read-only – has access only to the Reports page, and only to “Export as
PDF” functionality.
2.10.2 Users
The SLA Plugin application offers two main possibilities of users:
1) Application users, which allows the administrator to create users and grant the appropriate
roles.
2) PRTG Users, which allows you to login using your PRTG credentials.
By default, when logging in first time with the PRTG credentials, the users is assigned with the
“Reporting read-only” role.
2.10.3 Create new user
To create a new user, simply select ADD from the upper right corner of the page. Fill in the
mandatory (Username, Email, First name, Last name, Password) and grant the correct access role.
Figure 55 - Settings Menu
PRTG SLA Plugin Working with PRTG SLA Plugin
CORP-IT +41 445 860 187 Langfeldstrasse 53, 8500 Frauenfeld, [email protected] 6/23/2020 Switzerland www.corp-it.ch Page 31 of 31
Figure 56 - Add user
2.10.4 Modify users
As long as you are logged in with an administrator account, you can
modify any existing user as follows:
- Edit user: After the user has been created, you can edit any
field, by selecting the Edit option from the user menu.
- Delete user: The account will be removed entirely and will need
to be recreated if necessary.
- Reset password: After selecting this option, a new password
will be generated for the user and send it via email.
After the user loggs in with the new password, he can change it
at any time from the settings menu, under Change password.
- Set as inactive: The account will still exist but will not be
accessible until you set it as active again.
2.10.5 User groups
From this menu, you can group together users,
according to your needs.
Figure 57 - Modify User Menu
Figure 58 - Change Password
Figure 59 - Add User Group