English
User Guide
SLA

SLA

Configure and track Service Level Agreements for your components.

Overview

SLA (Service Level Agreement) configurations help you:

  • Define uptime targets for components
  • Track compliance against targets
  • Generate SLA reports
  • Display SLA status on dashboards

Creating an SLA Configuration

  1. Navigate to Settings > SLA
  2. Click "New SLA"
  3. Configure:

Basic Settings

FieldDescriptionExample
NameSLA identifier"Production API SLA"
TargetUptime percentage99.9%
PeriodMeasurement periodMonthly, Quarterly, Yearly

Component Selection

Select one or more components to track:

  1. Under "Components", check the components to include
  2. SLA compliance is calculated across all selected components
  3. Any component downtime affects overall SLA

For multi-component SLAs, the overall uptime is the average of all component uptimes.

SLA Calculation

Uptime Calculation

Uptime % = (Total Time - Downtime) / Total Time × 100

What Counts as Downtime

Component TypeDowntime Counted
ENDPOINTFailed health checks
SERVICEStatus set to Major Outage
METRICValue above critical threshold

Excluded Time

Time not counted against SLA:

  • Scheduled maintenance (if configured)
  • Time before component creation
  • Excluded time windows (if configured)

SLA Targets

Common SLA targets:

TargetMonthly Downtime
99%~7.3 hours
99.9%~43 minutes
99.95%~22 minutes
99.99%~4.4 minutes
99.999%~26 seconds

Viewing SLA Status

Dashboard View

The SLA section shows:

  • Current period compliance
  • Days remaining in period
  • Minutes remaining in budget
  • Trend vs. previous period

Component View

Each component page shows:

  • 24h/7d/30d/90d uptime
  • SLA status if configured
  • Downtime events

SLA Reports

Generate compliance reports:

  1. Navigate to Settings > SLA
  2. Select an SLA configuration
  3. Click "Generate Report"
  4. Select period
  5. Download as PDF or CSV

Report Contents

  • Overall compliance percentage
  • Per-component breakdown
  • Downtime events with timestamps
  • Incident correlation

SLA Widgets

Display SLA on status pages:

Uptime Chart Widget

Shows historical uptime with colored bars:

  • Green: Above target
  • Yellow: Below target but above floor
  • Red: Below floor

SLA Gauge Widget

Circular progress indicator showing:

  • Current compliance percentage
  • Target line
  • Status color

API Access

List SLAs

curl http://localhost:3000/api/v1/sla \
  -H "Authorization: Bearer sk_live_xxx"

Create SLA

curl -X POST http://localhost:3000/api/v1/sla \
  -H "Authorization: Bearer sk_live_xxx" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Production SLA",
    "target": 99.9,
    "period": "monthly",
    "componentIds": ["comp-1", "comp-2"]
  }'

Get SLA Status

curl http://localhost:3000/api/v1/sla/{id}/status \
  -H "Authorization: Bearer sk_live_xxx"

Response:

{
  "current": 99.95,
  "target": 99.9,
  "isCompliant": true,
  "downtimeMinutes": 21.6,
  "remainingBudget": 21.4,
  "periodStart": "2026-01-01T00:00:00Z",
  "periodEnd": "2026-01-31T23:59:59Z"
}

Custom Uptime Thresholds

Customize how uptime percentages are colored:

  1. Navigate to Settings > Organization
  2. Configure "Uptime Display Thresholds":
ThresholdDefaultDescription
Green≥ 99%Good status
Yellow≥ 95%Warning status
Red< 95%Critical status

These affect dashboard and status page displays.

Best Practices

Target Selection

  • Be realistic based on architecture
  • Consider dependencies
  • Document exclusions clearly
  • Review targets quarterly

Component Selection

  • Include critical user-facing components
  • Group related components
  • Exclude non-critical services

Monitoring

  • Set alerts for approaching SLA breach
  • Review trends regularly
  • Investigate all downtime events

Reporting

  • Generate monthly reports
  • Share with stakeholders
  • Use data to drive improvements

Related Documentation

MetricsSettings