Clarify the setup instructions for rqworker #2997

Closed
opened 2025-12-29 18:24:32 +01:00 by adam · 2 comments
Owner

Originally created by @johnjwang on GitHub (Nov 5, 2019).

Change Type

[ ] Addition
[x] Correction
[ ] Deprecation
[ ] Cleanup (formatting, typos, etc.)

Proposed Changes

On the supervisord setup instructions, it should be stated that if the WEBHOOKS_ENABLED setting is False, then netbox-rqworker should not be running. Otherwise, it can lead to performance issues as described in this discussion. I suggest adding autostart = false to the [program:netbox-rqworker] configuration block to disable it.

Alternatively, WEBHOOKS_ENABLED is False in the default config as of v2.6.7 (9f7313e). If the intent was to enable webhooks by default, you may want to change that to True to help new users avoid this issue.

Originally created by @johnjwang on GitHub (Nov 5, 2019). <!-- Please indicate the nature of the change by placing an X in one of the boxes below. --> ### Change Type [ ] Addition [x] Correction [ ] Deprecation [ ] Cleanup (formatting, typos, etc.) <!-- Describe the proposed change(s). --> ### Proposed Changes On the [supervisord setup instructions](https://netbox.readthedocs.io/en/latest/installation/3-http-daemon/#supervisord-installation), it should be stated that if the `WEBHOOKS_ENABLED` setting is False, then `netbox-rqworker` should not be running. Otherwise, it can lead to performance issues as described in [this discussion](https://groups.google.com/d/topic/netbox-discuss/SrhbmNG6fvw/discussion). I suggest adding `autostart = false` to the `[program:netbox-rqworker]` configuration block to disable it. Alternatively, `WEBHOOKS_ENABLED` is False in the default config as of v2.6.7 (9f7313e). If the intent was to enable webhooks by default, you may want to change that to True to help new users avoid this issue.
adam closed this issue 2025-12-29 18:24:32 +01:00
Author
Owner

@jeremystretch commented on GitHub (Nov 6, 2019):

This will be addressed in v2.7. Please see #3408.

@jeremystretch commented on GitHub (Nov 6, 2019): This will be addressed in v2.7. Please see #3408.
Author
Owner

@squigley commented on GitHub (Jan 16, 2020):

Just wanted to add that this is still an issue in 2.6.12, but I acknowledge that it is not expected to be fixed until 2.7. Perhaps 2.6.13+ could have a note added to the configuration.py suggesting that it be enabled? as immediately setting "WEBHOOKS_ENABLED = True", and doing nothing else immediately resolved the restarting/high CPU issue.

@squigley commented on GitHub (Jan 16, 2020): Just wanted to add that this is still an issue in 2.6.12, but I acknowledge that it is not expected to be fixed until 2.7. Perhaps 2.6.13+ could have a note added to the configuration.py suggesting that it be enabled? as immediately setting "WEBHOOKS_ENABLED = True", and doing nothing else immediately resolved the restarting/high CPU issue.
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#2997