Paths.hs

-- | Raw paths of the probe routes, assuming the standard "health" mount.
-- Use these in request-logger exclusion predicates and conformance-test
-- exemption lists instead of restating string literals.
module Servant.Health.Paths
  ( healthMountSegment,
    liveRawPath,
    readyRawPath,
    healthRawPaths,
  )
where

import Data.ByteString (ByteString)

-- | The path segment the 'Servant.Health.HealthApi' record is mounted under.
healthMountSegment :: ByteString
healthMountSegment = "health"

-- | Raw path of the liveness probe.
liveRawPath :: ByteString
liveRawPath = "/health/live"

-- | Raw path of the readiness probe.
readyRawPath :: ByteString
readyRawPath = "/health/ready"

-- | Both probe paths, for exclusion predicates that treat them alike.
healthRawPaths :: [ByteString]
healthRawPaths = [liveRawPath, readyRawPath]