ServicePilot SaaS Documentation

Policies

A policy is configuration that is in common and applied to parts, or the whole, of the supervision.

What are policies?

Policies can be thought of as collections of settings that apply to the whole configuration or are used to override package default settings. Different aspects of the configuration can be modified via policies. For example:

  • Define SNMP credentials to query SNMP agents
  • Change the frequency at which to query devices using SNMP
  • Override Status level thresholds
  • Consider or ignore alerts based on time periods (business hours vs out-of-hours alerting)
  • Raise alerts via email, webhooks
  • Specify Service Level Agreement limits for resources
  • Include custom web links in objects with parameters set with the object's details

Although policies may be applied to the whole configuration, some policies may include filters to limit their use to specific resources, objects, classes or views. Policies may also be associated with views and their sub-views as well as resources based on where they are used.

Types of policies

There are 6 different kinds of policies that can be defined in ServicePilot:

Policy type Use
SNMP Specify SNMP credentials that can be applied to resources making SNMP queries, network discovery credentials list and SNMP v3 Engine credentials to decode SNMP v3 Traps and Notifications
Monitoring Override polling and status settings for resources
Threshold Override or add indicator thresholds for object indicators
Alert Define automated actions to take when alert conditions are met
SLA Specify Service Level Objectives for objects, classes, packages or views
Web link Specify Custom web links to add to objects

Adding a policy

  1. Using a user with administrative privileges, log in to ServicePilot.
  2. Open configuration Configuration icon
  3. Navigate to Policies Policies Menu Item
  4. Click on Add a PolicyAdd a policy button
  5. Complete the Add Policy dialog. Complete Policy Dialog
  6. Click OK OK button
  7. Finally, click Save Save button

Note: Use a good naming convension for policies as the list may become large and applying policies becomes difficult if they are not given meaningful names. A name like threshold_disk-usage_80-90 indicates the type of policy, what it applies to and the threshold values used.

SNMP Policies

SNMP policies are used to specify credentials applied to resources that need to poll devices using SNMP. A default SNMP policy can be defined to be used when other policies are not specifically attributed to resources.

Note: Only 1 SNMP policy can be applied to any particular resource or set as the default SNMP policy.

Add SNMPv3 policy

Monitoring Policies

Monitoring policies are used to define custom polling rules that override the default polling settings set in the packages (polling frequency, polling discovery frequency, monitoring periods, no response status).

Monitoring policies can be applied to specific classes and packages. The policies can then be applied globally to change all classes or packages filtered or to a subset of the monitoring hierarchy by applying the policy to a view and its sub-views.

Add Monitoring policy

Threshold Policies

Threshold policies are used to specify indicator boundary definitions that can override default threshold settings set in packages. Each policy can change up to 5 different indicator's thresholds.

Threshold policies can be applied globally to affect all thresholds of the defined classes indicator thresholds or to a view to change the thresholds for all resouces in that view and sub-views. The policy might be applied to a resource to modify the threshold for all objects within the resource. Finally, the policy might be applied to a resource with an object filter set so that the thresholds would be changed only for the named objects.

Add Threshold policy

Note: Where conditions are used, the order in which the conditions are defined is important as the first condition that returns true will stop the verification of the subsequent conditions. In the example above, if the order of the conditions were reversed and the indicator "Physical Memory Usage" had a value of 99%, the first condition of value > 75 would have returned true and the status of the resource would change to 1 (minor) instead of the intended status 3 (critical).

Alert Policies

Alert policies are covered in more detail in the Alerting documentation.

Alert policies are used to automatically execute actions in the event that predefined conditions are met. Trigger conditions include:

  • Change in status of views/resources/objects/indicators
  • Reception of SNMP Traps or Syslogs

Different actions can be set to execute automatically when the conditions are met:

  • Send a predefined Email to an address with all relevant information pertaining to the alert
  • Send a Webhook message to another web application
  • Send a UDP or Sysog message
  • Send an SNMP Trap

Add Alert policy condition

Add Alert policy action

SLA Policies

SLA Policies are used to specify Service Level Objective thresholds for both availability and performance of resources or groups thereof. If the availability or good performance time falls below the objective set then this indicates a breach of a SLA.

Add SLA policy

Web Link Policies are used to include custom link to the ServicePilot web interface. The URL specified in the policy can include variables based on the properties of the object in scope. The link could therefore point to other ServicePilot web pages that need these parameters or to external systems that might use these values. Web Link Policies are filtered by class or package and can then be applied to portions of the view hierarchy with an object filter.

Add Web Link policy

Using policies

All policies can be applied either as a default policy to the entire supervision or to specific parts of the supervision. To apply a policy to part of the supervision, associate the policy with a view and it will apply to the view and all of its sub-views and resources. Policies can be applied to resources, which will only affect the resource or they may be applied to a resource with an object filter, in which case only the listed objects will be affected.

By default

Policies can be applied by default to the entire supervision by simply ticking an option during the creation of the policy.

Add default policy

Notes

  • Only one SNMP policy can be declared as the default SNMP policy.
  • Alert policies with SNMP Trap or Syslog receipt conditions can only be applied by default as these conditions are not associated with views or resources.
  • A default policy will only take effect on resources where it is applicable. For example, a policy of type SNMP will only affect resources that use SNMP polling to monitor the target devices.

By view and all sub-views

Policies can be applied to views. This method will see the policy inherited by all the sub-views and resources within the parent view.

Apply policy on view

By resource

Policies can be applied as needed on a resource by resource basis. Only the objects of the resource to which the policy is applied will be affected.

Apply policy on resource

By objects within a resource

Policies can also be applied to a sub-set of objects within a resource. In the example below, a monitoring policy is applied to remove the disk usage alert on the D drive that is always 100% full, being dedicated as a swap volume.

Apply policy on object

What are time periods?

Time periods consist of two daily time spans and check-boxes for each week day. These weekly time period definitions can then be applied to different parts of the ServicePilot configuration.

Edit Time Periods

  1. Using a user with administrative privileges, log in to ServicePilot.
  2. Open configuration by clicking on the gears icon Configuration icon
  3. Navigate to Time periods Time periods Menu Item
  4. Click on + Add a time peroiod button Add a time period button
  5. Complete the Time period settings dialog
  6. Click OK OK button
  7. Finally, click Save Save button

Using time periods

Time periods may be included in a number of different places in the ServicePilot configuration.

Time period use Effect
In Monitoring policy settings Add one or more time periods in a monitoring policy to specify during what times the resources will be monitored. Outside of this time the resources will be in an unknown state.
In Alert policy settings Add one or more time periods in an alert policy to specify when this alert policy should be active. It can be useful to create different alert policies for out-of-hours alert handling.
In Scheduled report settings Add time periods to a scheduled report definition. When the report is run, it will only obtain data during the times specified by the time periods. This is particularly useful to only report during business hours when SLA statistics are required.

Get started Now