Skip to main content

Alerts

This article refers to SDK version v0.5.0. The current SDK version is N/A.

Mounted at client.alerts. Covers alerts and alert events raised by the platform. See the Overview for narrative examples, and the Alert Manager app for the equivalent Panel actions.

Concept

Alert Manager. A Marketplace app an operator deploys to a node to watch disk usage, service health, or custom variables, and raise alerts in Barbara Panel when something crosses a threshold.

Learn more

AlertsResource​

AlertsResource(client: BarbaraClient)

list​

list(*, offset: int = 0, size: int = 100) -> List[Alert]

The API defaults size to 0 (no results) when omitted, so this sends an explicit default instead of an empty query.

get​

get(alert_id: str) -> Alert

ack​

ack(alert_id: str) -> Alert

list_events​

list_events(
    *,
    offset: int = 0,
    size: int = 100,
    node_id: Optional[str] = None,
) -> List[AlertEvent]

get_event​

get_event(event_id: str) -> AlertEvent

AsyncAlertsResource​

AsyncAlertsResource(client: AsyncBarbaraClient)

list​

list(*, offset: int = 0, size: int = 100) -> List[Alert]

get​

get(alert_id: str) -> Alert

ack​

ack(alert_id: str) -> Alert

list_events​

list_events(
    *,
    offset: int = 0,
    size: int = 100,
    node_id: Optional[str] = None,
) -> List[AlertEvent]

get_event​

get_event(event_id: str) -> AlertEvent

Signatures above are generated from barbara-api-sdk 0.5.0 docstrings. If a new SDK release changes one, this page needs a re-sync — the surrounding prose does not update itself.