obelisk.asynchronous.core

This module contains the asynchronous API to interface with Obelisk CORE. These methods all return a Awaitable.

Relevant entrance points are Client.

This API vaguely resembles that of clients to previous Obelisk versions, but also significantly diverts from it where the underlying Obelisk CORE API does so.

Module Attributes

DataType

The possible types of data Obelisk can accept

Aggregator

Type of aggregation Obelisk can process

Datapoint

Datapoints resulting from queries are modeled as simple dicts, as fields can come and go depending on query.

Functions

type_suffix(metric)

Extracts the DataType from a string metric, useful for the dataType field in queries.

Classes

ChunkedParams(*, dataset[, groupBy, ...])

Client(client, secret, retry_strategy, kind)

IncomingDatapoint(*[, timestamp, labels, ...])

A datapoint to be submitted to Obelisk.

ObeliskPosition(*, lat, lng, elevation)

Format for coordinates as expected by Obelisk.

QueryParams(*, dataset[, groupBy, ...])

QueryResult(*[, cursor])