juturna.telemetry package

Subpackages

• juturna.telemetry.browser package
  • Module contents
    • BrowserTelemetry
      • BrowserTelemetry.record_telemetry()
      • BrowserTelemetry.requires
• juturna.telemetry.csv package
  • Module contents
    • CsvTelemetry
      • CsvTelemetry.record_telemetry()
      • CsvTelemetry.records()
      • CsvTelemetry.requires
      • CsvTelemetry.start()
      • CsvTelemetry.stop()
• juturna.telemetry.memory package
  • Module contents
    • MemoryTelemetry
      • MemoryTelemetry.record_telemetry()
      • MemoryTelemetry.records()
      • MemoryTelemetry.requires
      • MemoryTelemetry.start()
      • MemoryTelemetry.stop()

Module contents

class juturna.telemetry.TelemetryContext(transport: TransportBackend, worker: str, pipe_path: str)

Bases: object

What a pipeline hands to the telemetry manager it builds

pipe_path: str

transport: TransportBackend

worker: str

class juturna.telemetry.TelemetryManager(*args, **kwargs)

Bases: Protocol

Collects the telemetry records of a pipeline

record_telemetry(record_batch: list[tuple]) → None

Take a batch of records. It runs in the thread of a node: it must never block, and drops the batch rather than slow the node down.

records() → list[tuple]

The records collected so far, oldest first

requires: ClassVar[frozenset[str]]

start() → None

Start whatever the manager needs to collect the records

stop() → None

Write what is left and release what start acquired

juturna.telemetry.check_pipeline_telemetry(pipeline: dict) → None

Check the telemetry of a pipeline configuration.

The transport and the manager are built and dropped: their constructors validate the options and hold no resource (the csv file is opened on start).

Parameters:

pipeline (dict) – The pipeline entry of a pipeline configuration.

Raises:

ValueError – If the transport or the telemetry cannot be built from it.

juturna.telemetry.get_telemetry(spec: dict | None, ctx: TelemetryContext) → TelemetryManager | None

Build the telemetry manager a pipeline asks for.

Parameters:

• spec (dict | None) – The telemetry entry of the pipeline configuration: a dictionary with the name of the manager and its options. None means the telemetry is off.

• ctx (TelemetryContext) – The context of the pipeline.

Returns:

A new manager, or None if the telemetry is off.

Return type:

TelemetryManager | None

Raises:

ValueError – If the configuration does not ask for a registered manager with options it accepts, or the manager needs something the transport does not offer.

juturna.telemetry.tag_records(record_batch: list[tuple], worker: str) → list[tuple]

Append the worker to every record: message ids collide across workers