@@ -29,20 +29,18 @@ taskbadger.init(
29
29
)
30
30
```
31
31
32
- To track only certain tasks, you can use the ` includes ` and ` excludes ` parameters which take a list of task names
33
- or patterns:
32
+ ### System Integration Options
34
33
35
- ``` python
36
- CelerySystemIntegration(
37
- includes = [
38
- " myapp.tasks.*" ,
39
- " myapp.other_tasks.special_task"
40
- ],
41
- excludes = [
42
- " myapp.tasks.heartbeat" ,
43
- ]
44
- )
45
- ```
34
+ The ` CelerySystemIntegration ` class takes a number of optional parameters:
35
+
36
+ - ` auto_track_tasks ` : Set this to ` False ` to disable automatic tracking of tasks.
37
+ - ` includes ` : A list of task names or patterns to include. If this is set, only tasks that match one of the patterns
38
+ will be tracked.
39
+ - ` excludes ` : A list of task names or patterns to exclude. If this is set, tasks that match one of the patterns will
40
+ not be tracked.
41
+ - ` record_task_args ` : If ` True ` , the arguments passed to the task will be recorded in the Task Badger task data.
42
+
43
+ ==Since v1.4.0==
46
44
47
45
Exclusions take precedence over inclusions so if a task name matches both an include and an exclude, it will be
48
46
excluded.
@@ -135,6 +133,16 @@ my_task.apply_async(arg1, arg2, taskbadger_kwargs={
135
133
In both the decorator and `apply_async`, if individual keyword arguments are used as well as
136
134
the `taskbadger_kwargs` dictionary, the individual arguments will take precedence.
137
135
136
+
137
+ !!!note "Recording task args"
138
+
139
+ By default, the arguments passed to the task are not recorded in the Task Badger task data. To record the
140
+ arguments, set the `taskbadger_record_task_args` parameter to `True` in the task decorator or in the `apply_async` call.
141
+ This will override the value set in the `CelerySystemIntegration` if it is being used.
142
+
143
+ ==Since v1.4.0==
144
+
145
+
138
146
### Accessing the Task Object
139
147
140
148
The ` taskbadger.celery.Task ` class provides access to the Task Badger task object via the ` taskbadger_task ` property
0 commit comments