Skip to main content

A small Flask application that allows for Karton task and queue introspection.

Project description

Karton Dashboard

A small Flask application for Karton task and queue introspection.

Usage

First of all, make sure you have setup the core system: https://github.com/CERT-Polska/karton

Then install karton-dashboard from PyPi:

$ pip install karton-dashboard

$ karton-dashboard run -h 127.0.0.1 -p 5000

The karton-dashboard is just a wrapper on the flask program, and it works with any arguments accepted by flask. For example karton-dashboard --help, or karton-dashboard run -h 0.0.0.0 -p 1234. See flask documentation for more information.

Xref buttons

If you have other systems that store artifacts related to a specific karton task there's an option to easily link them in the task view.

You'll need to set the xrefs options of dashboard section in your karton.ini configuration file like so:

[dashboard]
xrefs={"mwdb": "https://mwdb.cert.pl/?q=karton:{root_uid}"}

Each link will be rendered as a button in the task view like so:

Metrics

Karton tracks number of consumed, produced and crashed tasks for each service (identity).

Karton-dashboard exposes this information (in addition to some other task/queue statistics) on the /varz endpoint using Prometheus data format.

You can use this data to easily build custom karton dashboards and setup alerts for unusual events or high loads. Just point the data source URL to https://karton-dashboard/varz and configure the dashboard however you like.

Here are a few examples of how the data can be digested and presented in a grafana dashboard:

sum(karton_tasks{name!=""}) by (priority)

sum(karton_tasks{name!=""}) by (status)

sum(karton_tasks{name!=""}) by (name)

Co-financed by the Connecting Europe Facility by of the European Union

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

karton_dashboard-1.6.0-py3-none-any.whl (48.2 kB view details)

Uploaded Python 3

File details

Details for the file karton_dashboard-1.6.0-py3-none-any.whl.

File metadata

File hashes

Hashes for karton_dashboard-1.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 67e962c888be227d6e0e3b65fcc632a9041da36440adf03f8d1bd05518bce295
MD5 948ca451f41689af07e8a50db3e4d59d
BLAKE2b-256 6d62187bb3e80e3cb931a7053c034b82f254b172236e77a13e43d05eac2a5d0d

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page