Parapet.SLO.LoginJourney (parapet v1.0.0)

Copy Markdown View Source

Provides an out-of-the-box SLO definition for the standard login journey.

Experimental

This module is experimental in v1.x. Its API may change in a minor release with a single-version notice in CHANGELOG.md. See Stability & Deprecation Policy for details.

Summary

Functions

Registers the login journey SLO with the Parapet.SLO registry.

Functions

register(opts \\ [])

Registers the login journey SLO with the Parapet.SLO registry.

Options

  • :objective - The target objective percentage (default: 99.9).
  • :good_events - PromQL string for good events. (default: "sum(rate(parapet_journey_login_duration_milliseconds_count{outcome="success"}[5m]))")
  • :total_events - PromQL string for total events. (default: "sum(rate(parapet_journey_login_duration_milliseconds_count[5m]))")
  • :runbook - URL to the runbook for this SLO. (default: "https://example.com/runbooks/login-journey")