Getting started › From an API key to an Incident

From an API key to an Incident

Create a Resource, send it an Observation, and read the Rule result and the Incident with API v3 and the Python SDK 2.0.

Preview build. The Python SDK 2.0 is installed from a local wheel for the field test; it is not on PyPI yet. Do not install a prerelease from a package index.

You need a running Uptimer 2.0 with at least one Location (see the Quickstart) and Python 3.9 or later.

1. Create an API key

Open API keys → New key, name it, and copy the token. It is shown once. The key acts as you: it reads and writes what you may in each Workspace.

export UPTIMER_URL=http://localhost:8080/api
export UPTIMER_API_KEY=<the token>

2. Install the SDK wheel

Install the wheel file from the field-test pack into a clean environment:

python3 -m venv uptimer-env
uptimer-env/bin/pip install ./uptimer_python_sdk-2.0.0-py3-none-any.whl

3. Create a Resource and send an Observation

import os
import time

from uptimer import NotFoundError, UptimerClient

client = UptimerClient(api_key=os.environ["UPTIMER_API_KEY"], base_url=os.environ["UPTIMER_URL"])
client.check_compatibility()

ws = client.workspace(client.workspaces()[0].id)
location = client.locations()[0]

try:
    resource = ws.resources.get("checkout-api")
except NotFoundError:
    resource = ws.resources.create(
        template="website-check",
        key="checkout-api",
        name="Checkout API",
        meta={
            "url": "https://checkout.example.com/health",
            "locations": [location.id],
            "interval_value": 5,
            "interval_unit": "MINUTE",
            "failure_mode": "at_least_one",
            "confirm_after": 0,
            "recover_after": 0,
        },
    )

signal = resource.signals[0]
ws.resources.observe(resource.key, signal=signal.key, state="problem", labels={"status": "503"})

for _ in range(20):
    rule = ws.resources.get(resource.key).rules[0]
    if rule.open_incident:
        break
    time.sleep(0.5)
print(f"rule {rule.key}: {rule.status} - {rule.explanation}")

incident = ws.incidents.get(rule.open_incident)
print(f"incident {incident.id}: {incident.lifecycle}, {incident.confirmation}, {incident.condition}")
for step in incident.history:
    print(f"  {step.at:%H:%M:%S} {step.kind:<16} {step.explanation}")

uptimer-env/bin/python quickstart.py

rule availability: problem - 1 of 1 location failing
incident sexCVBKlJuaa: open, confirmed, problem
  18:29:32 opened           1 of 1 location failing
  18:29:32 confirmed        1 of 1 location failing

Every id is a public id. You never need a database row number.

The same with curl

H="Authorization: Bearer $UPTIMER_API_KEY"
API=$UPTIMER_URL/v3

WS=$(curl -s -H "$H" $API/workspaces | jq -r '.result[0].id')
LOC=$(curl -s -H "$H" $API/locations | jq -r '.result[0].id')

curl -s -H "$H" -X POST $API/workspaces/$WS/resources \
  -d '{"template": "website-check", "key": "orders-api", "name": "Orders API",
       "meta": {"url": "https://orders.example.com/health", "locations": ["'$LOC'"],
                "interval_value": 5, "interval_unit": "MINUTE",
                "failure_mode": "at_least_one", "confirm_after": 0, "recover_after": 0}}'

SIGNAL=$(curl -s -H "$H" $API/workspaces/$WS/resources/orders-api | jq -r '.result.signals[0].key')
curl -s -H "$H" -X POST $API/workspaces/$WS/resources/orders-api/observations \
  -d '{"signal": "'$SIGNAL'", "state": "problem"}'

curl -s -H "$H" $API/workspaces/$WS/resources/orders-api | jq '.result.rules[0]'

API v3 reference: every route, the error model and paging.
Python SDK reference: Incidents, filters, maintenance and errors.

From an API key to an Incident

1. Create an API key

2. Install the SDK wheel

3. Create a Resource and send an Observation

The same with curl

Next