|
1 | | -# Welcome to Task Badger Documentation |
| 1 | +# Task Badger Documentation |
2 | 2 |
|
3 | | -Task Badger is a specialized monitoring system designed to provide deep visibility into your background jobs and asynchronous tasks. While it doesn't handle task execution itself, Task Badger seamlessly integrates with popular task processing systems like Celery to give developers comprehensive insights into their task operations. With Task Badger, you can track task progress, analyze performance patterns, and debug issues across your distributed task processing infrastructure. Whether you're managing a small set of periodic jobs or orchestrating complex distributed workflows, Task Badger offers the monitoring and observability tools you need to ensure your tasks are running smoothly. |
| 3 | +Task Badger is a monitoring and observability platform for background jobs and async tasks. It integrates with task processing systems like Celery to give you visibility into task progress, performance, and failures. |
4 | 4 |
|
5 | 5 |  |
6 | 6 |
|
7 | | -## Key Features |
| 7 | +## Get Started |
| 8 | + |
| 9 | +Install the Python SDK: |
| 10 | + |
| 11 | +```bash |
| 12 | +pip install taskbadger |
| 13 | +``` |
| 14 | + |
| 15 | +Initialize with your [Project API Key](https://taskbadger.net): |
| 16 | + |
| 17 | +```python |
| 18 | +import taskbadger |
| 19 | + |
| 20 | +taskbadger.init(token="YOUR_API_KEY") |
| 21 | +``` |
8 | 22 |
|
9 | | -- **Task States**: Track the status of tasks with various states such as `pending`, `in_progress`, `completed`, `error`, and more. |
10 | | -- **Actions and Triggers**: Automate actions based on task events using flexible trigger definitions. |
11 | | -- **Integrations**: Connect with various services like email, webhooks, and more to extend the functionality of Task Badger |
12 | | -- **Monitoring and Alerts**: Stay informed with real-time monitoring and customizable alerts for task events. |
| 23 | +Create and track a task: |
13 | 24 |
|
14 | | -## Getting Started |
| 25 | +```python |
| 26 | +from taskbadger import Task, StatusEnum |
15 | 27 |
|
16 | | -To get started with Task Badger, check out the following sections: |
| 28 | +task = Task.create("my task") |
| 29 | +task.update(status=StatusEnum.PROCESSING, value=50) |
| 30 | +task.update(status=StatusEnum.SUCCESS, value=100) |
| 31 | +``` |
17 | 32 |
|
18 | | -- [Quick Start Guide](quick.md): Learn how to set up and start using Task Badger. |
19 | | -- [Task States](data_model.md): Understand the different states a task can be in and how they are managed. |
20 | | -- [Task Actions](data_model.md#task-actions): Discover how to configure actions and triggers to automate your workflows. |
21 | | -- [API Reference](api.md): Explore the API documentation to integrate Task Badger with your applications. |
22 | | -- [Python SDK](python.md): Get started with the Python SDK to interact with Task Badger programmatically. |
| 33 | +Or monitor Celery tasks automatically with the [Celery integration](python-celery.md): |
23 | 34 |
|
24 | | -## Community and Support |
| 35 | +```python |
| 36 | +from taskbadger.systems import CelerySystemIntegration |
| 37 | + |
| 38 | +taskbadger.init( |
| 39 | + token="YOUR_API_KEY", |
| 40 | + systems=[CelerySystemIntegration()] |
| 41 | +) |
| 42 | +``` |
| 43 | + |
| 44 | +Or track any shell command with the [CLI](cli.md): |
| 45 | + |
| 46 | +```bash |
| 47 | +taskbadger run "my task" -- ./script.sh |
| 48 | +``` |
| 49 | + |
| 50 | +## Key Features |
25 | 51 |
|
26 | | -Join our community to get help, share ideas, and stay updated with the latest news: |
| 52 | +- **Task tracking** — monitor status, progress, and metadata for any background job |
| 53 | +- **Celery integration** — automatic tracking of all Celery tasks with zero code changes |
| 54 | +- **Actions and triggers** — get notified via email, webhook, or other integrations on task events |
| 55 | +- **CLI** — monitor shell commands without writing code |
27 | 56 |
|
28 | | -- [GitHub](https://github.com/Task Badger): Report issues, contribute to the project, and browse the source code. |
29 | | -- [Twitter](https://twitter.com/@task_badger): Follow us for updates and announcements. |
| 57 | +## Learn More |
30 | 58 |
|
31 | | -We hope you find Task Badger useful and look forward to your feedback!# Welcome to Task Badger Documentation |
| 59 | +- [Quick Start](quick.md) — full setup walkthrough |
| 60 | +- [Python SDK](python.md) — SDK reference |
| 61 | +- [CLI](cli.md) — command line usage |
| 62 | +- [Data Model](data_model.md) — task states, actions, and triggers |
| 63 | +- [API Endpoints](api.md) — REST API reference |
0 commit comments