mogic/t3x-scheduler-status

API to monitor scheduler task execution status

Installs: 1 121

Dependents: 0

Suggesters: 0

Security: 0

Stars: 0

Watchers: 3

Forks: 0

Open Issues: 0

Type:typo3-cms-extension

v0.3.0 2024-05-06 06:58 UTC

This package is auto-updated.

Last update: 2024-05-06 13:35:04 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, disabled and running
  • 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. Include the routing configuration in your config/sites/*/config.yaml:

    imports:
      - { resource: 'EXT:scheduler_status/Configuration/Routes/Default.yaml' }
  5. Fetch the scheduler status:

    http://typo3.example.org/scheduler-status.json?token=mysecret

TYPO3

TYPO3 v11 and v12 are supported with v0.3.

TYPO3 v10 was supported up to v0.2.

API response

Example response:

{
  "status": "ok",
  "errored": 0,
  "late": 0,
  "running": 0,
  "longrunning": 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",
      "next_seconds": 600
    }
  ]
}

Field explanation:

status

Possible values:

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

Number of tasks that are currently running.

longrunning

Number of tasks that are still running and should have been started again already.

next_seconds

Number of seconds when the task will be running in. Negative if it should have started already but could not because it's still running.