mogic/t3x-scheduler-status

API to monitor scheduler task execution status

Installs: 60

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 2

Forks: 0

Open Issues: 0

Type:typo3-cms-extension

v0.1.2 2023-05-30 07:21 UTC

This package is auto-updated.

Last update: 2023-05-30 07:22:02 UTC


README

This TYPO3 extension provides a simple JSON API route that returns the scheduler status:

  • Overview status field if everything is fine
  • How many tasks failed, are late and disabled
  • Detailled information about each task

Setup

  1. Install this extension:

    $ composer require mogic/t3x-scheduler-status
    
  2. Include the TypoScript template "Scheduler status" into your root TypoScript template

  3. Configure the API key in the TypoScript constants

  4. Fetch the scheduler status:

    http://typo3.example.org/?type=9251355215&token=mysecret
    

TYPO3

TYPO3 10 and 11 are supported

API response

Example response:

{
  "status": "ok",
  "errored": 0,
  "late": 0,
  "disabled": 0,
  "tasks": [
    {
      "id": 2,
      "name": "IP-Adressen in Datenbanktabellen anonymisieren",
      "description": "",
      "disabled": false,
      "group": "admin",
      "groupid": 1,
      "late": false,
      "running": false,
      "last": null,
      "lasterror": null,
      "lastsuccess": false,
      "next": "2023-04-29T08:31:22+02:00"
    }
  ]
}

The status field may be:

  • ok when all is fine
  • error when one of the tasks had an error in their last run
  • late when one task was not started as planned