obelisk.sync.Obelisk

class obelisk.sync.Obelisk(client: str, secret: str, retry_strategy: ~obelisk.strategies.retry.RetryStrategy = <obelisk.strategies.retry.NoRetryStrategy object>, kind: ~obelisk.types.ObeliskKind = ObeliskKind.CLASSIC)

Bases: object

Component that contains all the logic to consume data from the Obelisk API (e.g. historical data, sse).

Wraps Consumer.

Obelisk API Documentation: https://obelisk.docs.apiary.io/

__init__(client: str, secret: str, retry_strategy: ~obelisk.strategies.retry.RetryStrategy = <obelisk.strategies.retry.NoRetryStrategy object>, kind: ~obelisk.types.ObeliskKind = ObeliskKind.CLASSIC)

Methods

__init__(client: str, secret: str, retry_strategy: ~obelisk.strategies.retry.RetryStrategy = <obelisk.strategies.retry.NoRetryStrategy object>, kind: ~obelisk.types.ObeliskKind = ObeliskKind.CLASSIC)

fetch_single_chunk(datasets: List[str], metrics: List[str] | None = None, fields: dict | None = None, from_timestamp: int | None = None, to_timestamp: int | None = None, order_by: dict | None = None, filter_: dict | None = None, limit: int | None = None, limit_by: dict | None = None, cursor: str | None = None) → QueryResult

Queries one chunk of events from Obelisk for given parameters, does not handle paging over Cursors.

Parameters

datasetsList[str]

List of Dataset IDs.

metricsOptional[List[str]] = None

List of Metric IDs or wildcards (e.g. *::number), defaults to all metrics.

fieldsOptional[List[str]] = None

List of fields to return in the result set. Defaults to [metric, source, value]

from_timestampOptional[int] = None

Limit output to events after (and including) this UTC millisecond timestamp, if present.

to_timestampOptional[int] = None

Limit output to events before (and excluding) this UTC millisecond timestamp, if present.

order_byOptional[dict] = None

Specifies the ordering of the output, defaults to ascending by timestamp. See Obelisk docs for format. Caller is responsible for validity.

filter_Optional[dict] = None

Limit output to events matching the specified Filter expression. See Obelisk docs, caller is responsible for validity.

limitOptional[int] = None

Limit output to a maximum number of events. Also determines the page size. Default is server-determined, usually 2500.

limit_byOptional[dict] = None

Limit the combination of a specific set of Index fields to a specified maximum number.

cursorOptional[str] = None

Specifies the next cursor, used when paging through large result sets.

query(datasets: List[str], metrics: List[str] | None = None, fields: dict | None = None, from_timestamp: int | None = None, to_timestamp: int | None = None, order_by: dict | None = None, filter_: dict | None = None, limit: int | None = None, limit_by: dict | None = None) → List[Datapoint]

Queries data from obelisk, automatically iterating when a cursor is returned.

Parameters

datasetsList[str]

List of Dataset IDs.

metricsOptional[List[str]] = None

List of Metric IDs or wildcards (e.g. *::number), defaults to all metrics.

fieldsOptional[List[str]] = None

List of fields to return in the result set. Defaults to [metric, source, value]

from_timestampOptional[int] = None

Limit output to events after (and including) this UTC millisecond timestamp, if present.

to_timestampOptional[int] = None

Limit output to events before (and excluding) this UTC millisecond timestamp, if present.

order_byOptional[dict] = None

Specifies the ordering of the output, defaults to ascending by timestamp. See Obelisk docs for format. Caller is responsible for validity.

filter_Optional[dict] = None

Limit output to events matching the specified Filter expression. See Obelisk docs, caller is responsible for validity.

limitOptional[int] = None

Limit output to a maximum number of events. Also determines the page size. Default is server-determined, usually 2500.

limit_byOptional[dict] = None

Limit the combination of a specific set of Index fields to a specified maximum number.

query_time_chunked(datasets: List[str], metrics: List[str], from_time: datetime, to_time: datetime, jump: timedelta, filter_: dict | None = None, direction: Literal['asc', 'desc'] = 'asc') → Generator[List[Datapoint], None, None]

Fetches all data matching the provided filters, yielding one chunk at a time. One “chunk” may require several Obelisk calls to resolve cursors. By necessity iterates over time, no other ordering is supported.

Parameters

datasetsList[str]

Dataset IDs to query from

metricsList[str]

IDs of metrics to query

from_timedatetime.datetime

Start time to fetch from

to_timedatetime.datetime

End time to fetch until.

jumpdatetime.timedelta

Size of one yielded chunk

filter_Optional[dict] = None

Obelisk filter, caller is responsible for correct format

directionLiteral[‘asc’, ‘desc’] = ‘asc’

Yield older data or newer data first, defaults to older first.

send(dataset: str, data: List[dict], precision: TimestampPrecision = TimestampPrecision.MILLISECONDS, mode: IngestMode = IngestMode.DEFAULT) → Response

Publishes data to Obelisk

Parameters

datasetstr

ID for the dataset to publish to

dataList[dict]

List of Obelisk-acceptable datapoints. Exact format varies between Classic or HFS, caller is responsible for formatting.

precisionTimestampPrecision = TimestampPrecision.MILLISECONDS

Precision used in the numeric timestamps contained in data. Ensure it matches to avoid weird errors.

modeIngestMode = IngestMode.DEFAULT

See docs for IngestMode.

Raises

ObeliskError

When the resulting status code is not 204, an empty ObeliskError is raised.

Attributes

loop: AbstractEventLoop

Event loop used to run interal async operations

async_obelisk: Obelisk

The actual implementation this synchronous wrapper refers to