monitor.component-state

def component_state(statuses: Sequence[CheckStatus], under_maintenance: bool) -> ComponentState

ComponentState = Literal["operational", "degraded", "partial-outage", "major-outage", "maintenance"]

from fune.monitor.component_state import component_state  # monitor.component-state@^1

from typing import Sequence

from .monitor_check_status import CheckStatus  ← from monitor.check-status ^1.0.0 · built alongside by fune
from .monitor_component_state_types import ComponentState


def component_state(statuses: Sequence[CheckStatus], under_maintenance: bool) -> ComponentState:
    """One component's state in Atlassian Statuspage's vocabulary. Maintenance
    wins, so planned work never pages anyone as an outage; the statuses are
    still checked, so a bad feed fails loudly even during maintenance."""
    if len(statuses) == 0:
        raise ValueError("statuses must not be empty")
    if not isinstance(under_maintenance, bool):
        raise ValueError("underMaintenance must be true or false")
    down = 0
    degraded = 0
    for s in statuses:
        if s == "down":
            down += 1
        elif s == "degraded":
            degraded += 1
        elif s != "up":
            raise ValueError("unknown check status: %s" % (s,))
    if under_maintenance:
        return "maintenance"
    if down == len(statuses):
        return "major-outage"
    if down > 0:
        return "partial-outage"
    return "degraded" if degraded > 0 else "operational"

Install

fune build

With that line in your source, in a Python project (language python in fune.project), fune build resolves it and its 1 dependency, pins them in fune.lock, downloads only the Python package of each, and builds the code above into your project’s .fune/build, one readable file per capability with a header linking back here. Or pin a range in fune.project and build in one step:

fune add monitor.component-state

The manifest, vectors and README with only the Python implementation. Install it without the registry with fune add ./monitor.component-state-1.0.0-python.fune, or fetch it from a terminal with fune pull monitor.component-state@1.0.0:python.

The whole function, every language, is one file too: monitor.component-state-1.0.0.fune, 9,719 bytes, sha256 cffd933922c240ddf102b7ac117550f261e261ec98c4c1781338eee2a23942d6. It installs into a project of any language.

# fune: before monitor.component-state

# fune: after monitor.component-state

# fune: replace monitor.check-status in monitor.component-state

# fune: step monitor.component-state after <n|label>

More from the author

The values here are kebab-case like the rest of the registry's enums; map them to Statuspage's snake_case when calling its API.

## The rule, in order

1. `underMaintenance` is true: **maintenance**. Planned work is announced as such, not reported as an outage. 2. Every check down: **major-outage**. So a component with one check that is down is a major outage, not a partial one. 3. Some checks down: **partial-outage**. 4. Any check degraded: **degraded**. Degraded checks never add up to an outage. 5. Otherwise **operational**.

The statuses are validated even under maintenance, so a broken feed fails loudly instead of hiding behind a maintenance window. To decide whether a maintenance window is active, see `monitor.maintenance-window`; to combine one target's probe locations into a single status first, `monitor.check-status`.

## Errors

- `statuses must not be empty`: a component with no checks has no state. - `unknown check status: X` - `underMaintenance must be true or false`

## Sources

- Atlassian Support, "Show service status with components": https://support.atlassian.com/statuspage/docs/show-service-status-with-components/ (the five component statuses: Operational, Degraded performance, Partial outage, Major outage, Under maintenance). - Statuspage Status API (component `status` values `operational`, `degraded_performance`, `partial_outage`, `major_outage`): https://metastatuspage.com/api

Files