https://github.com/closeio/tasktiger-admin

Admin interface for TaskTiger
https://github.com/closeio/tasktiger-admin

Last synced: 1 day ago
JSON representation

Admin interface for TaskTiger

• Host: GitHub
• URL: https://github.com/closeio/tasktiger-admin
• Owner: closeio
• Created: 2015-11-17T00:53:55.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2024-06-26T17:48:20.000Z (6 months ago)
• Last Synced: 2024-12-16T08:14:54.777Z (9 days ago)
• Language: Python
• Size: 43.9 KB
• Stars: 32
• Watchers: 22
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst

Awesome Lists containing this project

README

        
===============

tasktiger-admin

===============

.. image:: https://circleci.com/gh/closeio/tasktiger-admin.svg?style=svg

    :target: https://circleci.com/gh/closeio/tasktiger-admin

.. image:: https://img.shields.io/badge/code%20style-black-000000.svg

	:target: https://github.com/psf/black

*tasktiger-admin* is an admin interface for TaskTiger_ using flask-admin. It

comes with an overview page that shows the amount of tasks in each queue for

each state (queued, active, scheduled, error). It lets you inspect queues and

individual tasks, as well as delete and retry tasks that errored out.

(Interested in working on projects like this? `Close`_ is looking for `great engineers`_ to join our team)

.. _TaskTiger: https://github.com/closeio/tasktiger

.. _Close: http://close.com

.. _great engineers: http://jobs.close.com

Quick start

-----------

.. code:: bash

  % tasktiger-admin

This will listen on the default port (5000) and connect to the default Redis

instance. Additional settings are available (see ``--help`` switch for

details).

For a more advanced integration, *tasktiger-admin* can be integrated in a Flask

app with an existing flask-admin by using the provided view in

``tasktiger_admin.views.TaskTigerView``.

Integration Links

-----------------

The ``TaskTigerView`` class takes an optional ``integration_config`` parameter

that can be used to render integration links on the admin Task Detail page.

These can be used to easily navigate to external resources like logging

infrastructure or a Wiki. ``integration_config`` should be a list of tuples

that specify the integration name and URL template.

The URL template supports four variables:

* ``task_id``: Current task id

* ``queue``: Task queue name

* ``execution_start``: Execution start time minus a 10 second buffer

* ``execution_failed``: Execution failed time plus a 10 second buffer

Example integration config that points to a logging website.

.. code:: python

  integration_config = [('Logs', 'https://logs.example.com/search/?'

                                 'task_id={{ task_id }}&'

                                 'start_time={{ execution_start }}&'

                                 'end_time={{ execution_failed }}')]