Skip to content
Avaloi

Jobs and progress

Watch every server change run as a job, read its steps and events, cancel one that has not started, and follow a bulk action across sites.

Anything that changes a server runs as a job: creating a site, clearing a cache, restarting PHP, changing a setting. Avaloi shows each job while it runs, so you never have to guess whether a change landed.

Open it

  1. Select the bell in the top bar. A small dot on the bell means jobs are running.
  2. Open the Jobs tab to see recent jobs and bulk actions. Running jobs show how far along they are, and finished ones show their result.
  3. Pick one to open its details.

Creating a site opens the details by itself.

The number on the bell counts unread notifications and failed jobs you have not seen yet. Running jobs never add to it. A failed job stops counting once you open the Jobs tab or select Clear finished.

With a keyboard, the Left and Right arrow keys move between the Notifications and Jobs tabs, and Escape closes the panel.

Read a job's details

The details show who asked for the job, a progress bar, the steps, and a live event log. A screen reader announces each step as it changes.

The page keeps updating even if the live connection drops, and it picks up where it left off. If you reload the page, Avaloi resumes the jobs you were watching.

Job states

A job can be:

  • Queued: waiting to start.
  • Sent to the server: handed to the server that will run it.
  • Running: in progress, with steps and events arriving.
  • Done: finished with success.
  • Failed: stopped with an error. The details say what went wrong in plain words.
  • Cancelled: stopped at your request.

Cancel or stop a job

Use Cancel on a queued job to stop it before it starts. Use Stop on a running job to ask it to stop at its next safe point. You need the cancel permission for either. See Roles.

Bulk actions

A bulk action, such as clearing the cache on several sites, shows one progress bar and a result for each site. Avaloi runs it as a job group: one parent and one child per environment, so one site's failure does not stop the others.

Full history

Open View all jobs to filter the full history by status and type.

Servers and test sites

The first site in a region starts a server, and that takes a few minutes. A test site runs on a simulated server, so it never starts one.

Quick answers

My job says failed. What do I do? Open the details. The error is in plain words, and the activity log records who started the job. Fix the cause and run the change again.

I closed the tab while a job ran. Did it stop? No. Jobs run on the server. Open the bell, then the Jobs tab, to find it again.

Can I cancel a running job? You can ask it to stop. It stops at its next safe point, not in the middle of a step.

API

  • GET /v1/jobs
  • GET /v1/jobs/{id}
  • GET /v1/jobs/{id}/events
  • POST /v1/jobs/{id}/cancel
  • GET /v1/job-groups/{id}
  • POST /v1/bulk

GET /v1/jobs/{id}/events sends server-sent events. It replays past events, then follows new ones until the job ends.

Still stuck?

Email [email protected] with your site name and what you tried, or send us a message.