SlosClient¶

Client for the Kibana SLOs (Service Level Objectives) API.

SLOs let you set measurable targets (availability, latency, …) for your services based on Elasticsearch data and track error budgets against those targets. The SLO APIs require an appropriate license (Platinum or trial).

All endpoints are space-scoped: the official API paths are rooted at /s/{spaceId}/api/observability/slos. Every method therefore accepts space_id (None targets the default space) and validate_spaces to override space-existence validation per call.

class kibana._sync.client.slos.SlosClient(client, default_space_id=None, validate_spaces=True)[source]¶

Bases: NamespaceClient

Client for the Kibana SLOs (Service Level Objectives) API.

Example

>>> from kibana import Kibana
>>> client = Kibana("http://localhost:5601", api_key="...")
>>>
>>> # Create an SLO based on a custom KQL indicator
>>> slo = client.slos.create(
...     name="my-service availability",
...     description="99% of requests are good over 30 days",
...     indicator={
...         "type": "sli.kql.custom",
...         "params": {
...             "index": "my-service-logs",
...             "good": "status: ok",
...             "total": "",
...             "timestampField": "@timestamp",
...         },
...     },
...     time_window={"duration": "30d", "type": "rolling"},
...     budgeting_method="occurrences",
...     objective={"target": 0.99},
... )
>>> slo_id = slo.body["id"]
>>>
>>> # Fetch it back, then clean up
>>> client.slos.get(slo_id=slo_id)
>>> client.slos.delete(slo_id=slo_id)

Creating SLOs

Create an SLO with the create() method:

from kibana import Kibana

client = Kibana("http://localhost:5601", api_key="your_api_key")

# Create an SLO based on a custom KQL indicator
slo = client.slos.create(
    name="my-service availability",
    description="99% of requests are good over 30 days",
    indicator={
        "type": "sli.kql.custom",
        "params": {
            "index": "my-service-logs",
            "good": "status: ok",
            "total": "",
            "timestampField": "@timestamp",
        },
    },
    time_window={"duration": "30d", "type": "rolling"},
    budgeting_method="occurrences",
    objective={"target": 0.99},
)

slo_id = slo.body["id"]

Finding and Retrieving SLOs

# Get a single SLO (with its computed summary)
slo = client.slos.get(slo_id=slo_id)

# Find SLOs with a KQL query
results = client.slos.find(kql_query="slo.name:my-service*")
for slo in results.body["results"]:
    print(slo["name"], slo["summary"]["status"])

# List SLO definitions
definitions = client.slos.find_definitions(search="my-service*")

SLO Lifecycle

# Disable and re-enable an SLO
client.slos.disable(slo_id=slo_id)
client.slos.enable(slo_id=slo_id)

# Reset an SLO (recompute rollup data from scratch)
client.slos.reset(slo_id=slo_id)

# Delete an SLO
client.slos.delete(slo_id=slo_id)

Bulk Operations

# Bulk delete SLOs (asynchronous server-side task)
task = client.slos.bulk_delete(slo_ids=[slo_id, "another-slo-id"])

# Check the status of the bulk delete task
status = client.slos.bulk_delete_status(task_id=task.body["taskId"])

find(*, kql_query=None, size=None, search_after=None, page=None, per_page=None, sort_by=None, sort_direction=None, hide_stale=None, space_id=None, validate_spaces=None)[source]¶

Get a paginated list of SLOs with their summaries.

GET /api/observability/slos

Parameters:

kql_query (str | None) – A valid KQL query to filter SLOs with, e.g. 'slo.name:latency* and slo.tags : "prod"'.
size (int | None) – The page size to use for cursor-based pagination (must be used together with search_after). Default 1.
search_after (list[str] | None) – The cursor to use for fetching the results from, when using a cursor-based pagination.
page (int | None) – The page number to return (default 1). Offset-based pagination; mutually exclusive with size/search_after.
per_page (int | None) – The number of SLOs to return per page (default 25, maximum 5000).
sort_by (str | None) – Sort by field. One of "sli_value", "status", "error_budget_consumed", "error_budget_remaining" (default "status").
sort_direction (str | None) – Sort order, "asc" (default) or "desc".
hide_stale (bool | None) – Hide stale SLOs from the list as defined by the stale SLO threshold in SLO settings.
space_id (str | None) – Space to operate on; None targets the default space.
validate_spaces (bool | None) – Override space-existence validation for this call.

Returns:

ObjectApiResponse with page, perPage, total and results (a list of SLOs with their summary).

Raises:

BadRequestError – If a query parameter is invalid (400).
AuthenticationException – If authentication fails (401).
AuthorizationException – If insufficient privileges (403).

Return type:

SlosClient¶

AsyncSlosClient¶