SLA TimerAppearance
Getting Started
Installation
You can install the sla-timer via composer:
$ composer require sifex/sla-timer
Requirements
php- Version 8.0 or higher
Example Usage
💡 About SLAs
Before we dive in, ensure you understand what SLAs & SLA Timers are by exploring About SLAs ›
Let's set up an SLA timer similar to the schedule shown below.
For this example, we're working in the week of 25th - 29th July 2022, but the library works over as long as you want*.
To create a new SLA Timer, we can start by defining our SLA Schedule:
require 'vendor/autoload.php';
use Sifex\SlaTimer\SLA;
use Sifex\SlaTimer\SLABreach;
use Sifex\SlaTimer\SLASchedule;
/**
* Create a new SLA between 9am and 5:30pm weekdays
*/
$sla = SLA::fromSchedule(
SLASchedule::create()->from('09:00:00')->to('17:30:00')
->onWeekdays()
);
We can define out breaches by calling the addBreaches method on our SLA
Â
Â
/**
* Define two breaches, one at 24 hours, and the next at 100 hours
*/
$sla->addBreaches([
new SLABreach('First Response', '24h'),
new SLABreach('Resolution', '100h'),
]);
Now that our SLA Schedule and SLA Breaches are defined, all we have to do is give our subject "creation time" – or our SLA start time – to either the status method, or the duration method.
// Given the time now is 14:00:00 29-07-2022
$status = $sla->status('05:35:40 25-07-2022'); // SLAStatus
$status->breaches; // [SLABreach] [0: { First Response } ]
$duration = $sla->duration('05:35:40 25-07-2022'); // CarbonInterval
$duration->forHumans(); // 1 day 15 hours
Please note:
By default, if the SLA is still running, Carbon::now() is used as the comparison time.
Timestamp Parsing:
Any timestamp that's understood by Carbon::parse() can be used here!
Timezone Heads up!
All times should be in UTC. If your datetimes are not in UTC, you can see our Dealing with Timezones guide here.
Stopping SLAs
To stop the SLA, simply pass in the date & time the SLA should be stopped into the status or duration method.
// Given the time now is 14:00:00 29-07-2022
$status = $sla->status('05:35:40 25-07-2022', '10:00:00 26-07-2022'); // SLAStatus
$status->breaches; // []
$duration = $sla->duration('05:35:40 25-07-2022', '10:00:00 26-07-2022'); // CarbonInterval
$duration->forHumans(); // 9 hours 30 minutes
Setting up Pause Periods
Sometimes we will want to pause our timer, start this, head over to "Pausing the SLA"
Disclaimers
* sifex/sla-timer is still inefficient at calculating SLAs over periods longer than a month.