theseeker-status 0.1.0

Python SDK for reporting TheSeeker status events.

theseeker-status

Python SDK for sending signed status events to TheSeeker ingest.

Install

pip install theseeker-status

Usage

import os

from theseeker_status import RESULT_OK, create_status_client

status = create_status_client(
    key_id=os.environ["THESEEKER_INGEST_KEY_ID"],
    secret=os.environ["THESEEKER_INGEST_SECRET"],
    endpoint="https://ingest.theseeker.io",
    slug="homepage",
)

status.report(
    RESULT_OK,
    latency_ms=123,
    message="homepage responded normally",
    metrics={"dnsMs": 12, "tlsMs": 30},
)

endpoint can be either the full events URL (https://ingest.theseeker.io/v1/events) or the base URL (https://ingest.theseeker.io). Base URLs are sent to /v1/events automatically.

If a client-level slug is not configured, pass it per report:

status = create_status_client(
    key_id=os.environ["THESEEKER_INGEST_KEY_ID"],
    secret=os.environ["THESEEKER_INGEST_SECRET"],
    endpoint="https://ingest.theseeker.io/v1/events",
)

status.report("degraded", latency_ms=950, slug="checkout-api")

Event shape

The SDK sends a single top-level event:

{"slug":"homepage","result":"ok","latencyMs":123,"message":"homepage responded normally","metrics":{"dnsMs":12}}

Valid results are ok, degraded, and down.

Signing

Requests include X-Ingest-Key-Id, X-Timestamp, X-Nonce, and X-Signature. The signed payload is:

METHOD.upper() + PATH + TIMESTAMP + NONCE + sha256_hex(body_bytes)

The same compact JSON bytes are used for signing and transmission.