Skip to content

Commit

Permalink
Merge pull request #127 from hennevogel/bugfix/job-docu
Browse files Browse the repository at this point in the history
Add missing Active Job documentation
  • Loading branch information
hennevogel authored Aug 21, 2020
2 parents 5f00eb3 + bafa20f commit 8ade32a
Showing 1 changed file with 26 additions and 0 deletions.
26 changes: 26 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,6 +132,32 @@ Reported tags:
name: "Post Load"
```

### Active Job

Reported ActiveSupport instrumentation hooks:

- [enqueue.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#enqueue-active-job)
- [perform_start.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-start-active-job)
- [perform.active\_job](https://guides.rubyonrails.org/active_support_instrumentation.html#perform-active-job)

Reported values:

```ruby
value: 89.467
```

Reported tags:

```ruby
hook: ["enqueue", "perform_start", "perform"],
state: ["queued", "running", "succeeded", "failed"],
job: "SomeJobClassName",
queue: "queue_name"
```

*Note*: Only the measurements with the hook `perform` report a duration in the value.
The other hooks are counters and always report a value of `1`.

## Configuration

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

0 comments on commit 8ade32a

Please sign in to comment.