obelisk.sync.producer.Producer

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

Bases: object

Synchronous equivalient of Producer, to publish data to Obelisk.

Methods

send(dataset, data[, precision, mode])

Publishes data to Obelisk

__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, secret[, retry_strategy, kind])
send(dataset, data[, precision, mode])	Publishes data to Obelisk

Attributes

loop
async_producer

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.