Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
adamlogic committed May 6, 2023
1 parent 182a79a commit 674ecc6
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,6 +64,8 @@ gem "judoscale-que"

For most apps, no additional configuration is needed. See the [configuration](#configuration) section below for all available options.

Note that if you aren't using Rails, you'll need to start the reporter manually. See below.

## Worker-only apps

If your app doesn't have a web process, you don't _have_ to include the "judoscale-rails" gem. If you omit it, you'll need to start the reporter manually:
Expand All @@ -73,6 +75,8 @@ require "judoscale/reporter"
Judoscale::Reporter.start
```

You should do this _after_ you've configured your job backend (such as `Sidekiq.configure_server`).

## What data is collected?

The reporter runs in its own thread so your web requests and background jobs are not impacted. The following data is submitted periodically to the Judoscale API:
Expand Down

0 comments on commit 674ecc6

Please sign in to comment.