starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-11 21:10:29 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

Custom scripts with job_timeout more than RQ_DEFAULT_TIMEOUT failed when rescheduled #10363

New Issue
Closed
opened 2025-12-29 21:30:30 +01:00 by adam · 3 comments
adam commented 2025-12-29 21:30:30 +01:00
Owner
Copy Link

Originally created by @miaow2 on GitHub (Oct 15, 2024).

Originally assigned to: @miaow2 on GitHub.

Deployment Type

Self-hosted

Triage priority

I volunteer to perform this work (if approved)

NetBox Version

v4.1.3

Python Version

3.12

Steps to Reproduce

  1. Create script with job_timeout more than RQ_DEFAULT_TIMEOUT, for example, the default timeout is 300 secs, setting job_timeout to 500 and inside script only sleep for 400 secs
from time import sleep

from extras.scripts import Script


class TestScript(Script):
    class Meta:
        job_timeout = 500

    def run(self, data, commit):
        sleep(400)
  1. Run script with interval, for example 3 minutes

Expected Behavior

Script runs successfully and all scheduled after scripts are successful too

Observed Behavior

First running will be successful, but after that all scheduled jobs will fail with JobTimeoutException

[DJANGO] ERROR 2024-10-15 11:45:28,255 scripts 160778 140373397688448 An exception occurred: `JobTimeoutException: Task exceeded maximum timeout value (300 seconds)`

Traceback (most recent call last):
  File "/home/miaow/work/netbox/netbox/extras/jobs.py", line 45, in run_script
    script.output = script.run(data, commit)
                    ^^^^^^^^^^^^^^^^^^^^^^^^
  File "/home/miaow/work/netbox/netbox/scripts/test_script.py", line 11, in run
    sleep(400)
  File "/home/miaow/work/netbox/venv/lib/python3.12/site-packages/rq/timeouts.py", line 63, in handle_death_penalty
    raise self._exception('Task exceeded maximum timeout value ({0} seconds)'.format(self._timeout))
rq.timeouts.JobTimeoutException: Task exceeded maximum timeout value (300 seconds)

This happens because ScriptView passes job_timeout into ScriptJob,

but rescheduling mechanism does not pass this argument into enqueue method

Originally created by @miaow2 on GitHub (Oct 15, 2024). Originally assigned to: @miaow2 on GitHub. ### Deployment Type Self-hosted ### Triage priority I volunteer to perform this work (if approved) ### NetBox Version v4.1.3 ### Python Version 3.12 ### Steps to Reproduce 1. Create script with `job_timeout` more than `RQ_DEFAULT_TIMEOUT`, for example, the default timeout is 300 secs, setting `job_timeout` to 500 and inside script only sleep for 400 secs ```python from time import sleep from extras.scripts import Script class TestScript(Script): class Meta: job_timeout = 500 def run(self, data, commit): sleep(400) ``` 2. Run script with interval, for example 3 minutes ### Expected Behavior Script runs successfully and all scheduled after scripts are successful too ### Observed Behavior First running will be successful, but after that all scheduled jobs will fail with `JobTimeoutException` ``` [DJANGO] ERROR 2024-10-15 11:45:28,255 scripts 160778 140373397688448 An exception occurred: `JobTimeoutException: Task exceeded maximum timeout value (300 seconds)` Traceback (most recent call last): File "/home/miaow/work/netbox/netbox/extras/jobs.py", line 45, in run_script script.output = script.run(data, commit) ^^^^^^^^^^^^^^^^^^^^^^^^ File "/home/miaow/work/netbox/netbox/scripts/test_script.py", line 11, in run sleep(400) File "/home/miaow/work/netbox/venv/lib/python3.12/site-packages/rq/timeouts.py", line 63, in handle_death_penalty raise self._exception('Task exceeded maximum timeout value ({0} seconds)'.format(self._timeout)) rq.timeouts.JobTimeoutException: Task exceeded maximum timeout value (300 seconds) ``` This happens because `ScriptView` [passes](https://github.com/netbox-community/netbox/blob/develop/netbox/extras/views.py#L1182) `job_timeout` into `ScriptJob`, but rescheduling mechanism does not [pass](https://github.com/netbox-community/netbox/blob/develop/netbox/netbox/jobs.py#L71) this argument into `enqueue` method
adam added the type: bugstatus: acceptedseverity: low labels 2025-12-29 21:30:30 +01:00
adam closed this issue 2025-12-29 21:30:30 +01:00
adam commented 2025-12-29 21:30:31 +01:00
Author
Owner
Copy Link

@arthanson commented on GitHub (Oct 15, 2024):

@miaow2 it looks like you know where this is, do you want to work on a fix for it?

@arthanson commented on GitHub (Oct 15, 2024): @miaow2 it looks like you know where this is, do you want to work on a fix for it?
adam commented 2025-12-29 21:30:31 +01:00
Author
Owner
Copy Link

@miaow2 commented on GitHub (Oct 15, 2024):

@arthanson yeah, I want to work on this fix

@miaow2 commented on GitHub (Oct 15, 2024): @arthanson yeah, I want to work on this fix
adam commented 2025-12-29 21:30:31 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Oct 15, 2024):

Thanks @miaow2, I've assigned this to you.

@jeremystretch commented on GitHub (Oct 15, 2024): Thanks @miaow2, I've assigned this to you.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label severity: low status: accepted type: bug
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#10363
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?