Events¶

Asyncz emits structured event objects when schedulers, stores, executors, and tasks change state. All event models live in asyncz.events.base, and the event code constants live in asyncz.events.constants.

Event models¶

SchedulerEvent¶

The base event type. It carries:

• code: the event code
• alias: the store or executor alias involved in the event, when relevant

TaskEvent¶

Extends SchedulerEvent with task-specific data:

• task_id
• store

TaskSubmissionEvent¶

Extends TaskEvent with:

• scheduled_run_times: the run times the scheduler submitted to an executor

TaskExecutionEvent¶

Extends TaskEvent with:

• scheduled_run_time
• return_value
• exception
• traceback

Common event codes¶

Import codes from asyncz.events.constants and register listeners with scheduler.add_listener(...).

Typical codes include:

• SCHEDULER_START
• SCHEDULER_SHUTDOWN
• TASK_ADDED
• TASK_REMOVED
• TASK_SUBMITTED
• TASK_EXECUTED
• TASK_ERROR
• TASK_MISSED

Adding a listener¶

from datetime import timezone as tz
import logging

from asyncz.events.constants import TASK_ADDED, TASK_REMOVED
from asyncz.schedulers.asyncio import AsyncIOScheduler

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

# Create the scheduler
scheduler = AsyncIOScheduler(timezone=tz.utc)


def my_custom_listener(event):
    if not event.exception:
        logger.info("All good")
    else:
        logger.exception("Problem with the task")


# Add event listener
scheduler.add_listener(my_custom_listener, TASK_ADDED | TASK_REMOVED)