faust.sensors.base

Base-interface for sensors.

class faust.sensors.base.Sensor(*, beacon: mode.utils.types.trees.NodeT = None, loop: asyncio.events.AbstractEventLoop = None) → None

Base class for sensors.

This sensor does not do anything at all, but can be subclassed to create new monitors.

on_message_in(tp: faust.types.tuples.TP, offset: int, message: faust.types.tuples.Message) → None

Message received by a consumer.

Return type:None

on_stream_event_in(tp: faust.types.tuples.TP, offset: int, stream: faust.types.streams.StreamT, event: faust.types.events.EventT) → None

Message sent to a stream as an event.

Return type:None

on_stream_event_out(tp: faust.types.tuples.TP, offset: int, stream: faust.types.streams.StreamT, event: faust.types.events.EventT) → None

Event was acknowledged by stream.

Notes

Acknowledged means a stream finished processing the event, but given that multiple streams may be handling the same event, the message cannot be committed before all streams have processed it. When all streams have acknowledged the event, it will go through on_message_out() just before offsets are committed.

Return type:None

on_message_out(tp: faust.types.tuples.TP, offset: int, message: faust.types.tuples.Message) → None

All streams finished processing message.

Return type:None

on_topic_buffer_full(topic: faust.types.topics.TopicT) → None

Topic buffer full so conductor had to wait.

Return type:None

on_table_get(table: faust.types.tables.CollectionT, key: Any) → None

Key retrieved from table.

Return type:None

on_table_set(table: faust.types.tables.CollectionT, key: Any, value: Any) → None

Value set for key in table.

Return type:None

on_table_del(table: faust.types.tables.CollectionT, key: Any) → None

Key deleted from table.

Return type:None

on_commit_initiated(consumer: faust.types.transports.ConsumerT) → Any

Consumer is about to commit topic offset.

Return type:Any

on_commit_completed(consumer: faust.types.transports.ConsumerT, state: Any) → None

Consumer finished committing topic offset.

Return type:None

on_send_initiated(producer: faust.types.transports.ProducerT, topic: str, keysize: int, valsize: int) → Any

About to send a message.

Return type:Any

on_send_completed(producer: faust.types.transports.ProducerT, state: Any) → None

Message successfully sent.

Return type:None

logger = <Logger faust.sensors.base (WARNING)>

class faust.sensors.base.SensorDelegate(app: faust.types.app.AppT) → None

A class that delegates sensor methods to a list of sensors.

add(sensor: faust.types.sensors.SensorT) → None

Return type:None

remove(sensor: faust.types.sensors.SensorT) → None

Return type:None

on_message_in(tp: faust.types.tuples.TP, offset: int, message: faust.types.tuples.Message) → None

Return type:None

on_stream_event_in(tp: faust.types.tuples.TP, offset: int, stream: faust.types.streams.StreamT, event: faust.types.events.EventT) → None

Return type:None

on_stream_event_out(tp: faust.types.tuples.TP, offset: int, stream: faust.types.streams.StreamT, event: faust.types.events.EventT) → None

Return type:None

on_topic_buffer_full(topic: faust.types.topics.TopicT) → None

Return type:None

on_message_out(tp: faust.types.tuples.TP, offset: int, message: faust.types.tuples.Message) → None

Return type:None

on_table_get(table: faust.types.tables.CollectionT, key: Any) → None

Return type:None

on_table_set(table: faust.types.tables.CollectionT, key: Any, value: Any) → None

Return type:None

on_table_del(table: faust.types.tables.CollectionT, key: Any) → None

Return type:None

on_commit_initiated(consumer: faust.types.transports.ConsumerT) → Any

Return type:Any

on_commit_completed(consumer: faust.types.transports.ConsumerT, state: Any) → None

Return type:None

on_send_initiated(producer: faust.types.transports.ProducerT, topic: str, keysize: int, valsize: int) → Any

Return type:Any

on_send_completed(producer: faust.types.transports.ProducerT, state: Any) → None

Return type:None