Skip to content

Commit 8ade32a

Browse files
authored
Merge pull request #127 from hennevogel/bugfix/job-docu
Add missing Active Job documentation
2 parents 5f00eb3 + bafa20f commit 8ade32a

File tree

1 file changed

+26
-0
lines changed

1 file changed

+26
-0
lines changed

README.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,6 +132,32 @@ Reported tags:
132132
name: "Post Load"
133133
```
134134

135+
### Active Job
136+
137+
Reported ActiveSupport instrumentation hooks:
138+
139+
- [enqueue.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-active-job)
140+
- [perform_start.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-start-active-job)
141+
- [perform.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)
142+
143+
Reported values:
144+
145+
```ruby
146+
value: 89.467
147+
```
148+
149+
Reported tags:
150+
151+
```ruby
152+
hook: ["enqueue", "perform_start", "perform"],
153+
state: ["queued", "running", "succeeded", "failed"],
154+
job: "SomeJobClassName",
155+
queue: "queue_name"
156+
```
157+
158+
*Note*: Only the measurements with the hook `perform` report a duration in the value.
159+
The other hooks are counters and always report a value of `1`.
160+
135161
## Configuration
136162

137163
The only setting you actually need to configure is the name of the database

0 commit comments

Comments
 (0)