API Reference

This page contains the autogenerated docs for the classes which can be extended to write custom features.

Data Service

class celeryviz.data_service.AbstractEventRetriever

Bases: object

Abstract service for querying event data. Not in use currently, will be used when we start sending stored events to clients.

async fetch_events(*args, **kwargs) → List[dict]

Receive a list of event dictionaries from the data source.

class celeryviz.data_service.AbstractEventSink

Bases: object

Abstract service for dumping event data.

async dump_events(events: List[dict])

Dump a list of event dictionaries to the data store.

class celeryviz.data_service.FileEventSink(file_path: str)

Bases: AbstractEventSink

File-based implementation of the AbstractEventSink.

async dump_events(events: List[dict])

Dump a list of event dictionaries to a file.

class celeryviz.data_service.SocketioEventSink

Bases: AbstractEventSink

Socket.IO implementation of the AbstractEventSink.

class ClientNamespace(namespace=None)

Bases: AsyncNamespace

on_connect(sid, environ)

on_disconnect(sid)

async dump_events(events: List[dict])

Emit each event dictionary to the Socket.IO client.

celeryviz.data_service.get_event_sinks()

Server

class celeryviz.server.Server(loop: AbstractEventLoop, port: int | None = None, event_data_sinks: List[AbstractEventSink] | None = None)

Bases: object

async event_handler(data)

The dump_events if called for each event received for now. This can be optimized to batch process events in future.

frontend_app()

start()