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

Handle exception when a webhook is triggered but Redis is unreachable #3330

New Issue
Closed
opened 2025-12-29 18:27:46 +01:00 by adam · 2 comments
adam commented 2025-12-29 18:27:46 +01:00
Owner
Copy Link

Originally created by @jeremystretch on GitHub (Feb 14, 2020).

Originally assigned to: @jeremystretch on GitHub.

Environment

  • Python version: 3.6.9
  • NetBox version: 2.7.6

Proposed Functionality

When NetBox attempts to enqueue a webhook and Redis is unreachable, an exception is raised:

  File "/home/jstretch/.virtualenvs/netbox/lib/python3.6/site-packages/redis/connection.py", line 544, in connect
    raise ConnectionError(self._error_message(e))
redis.exceptions.ConnectionError: Error 111 connecting to localhost:6379. Connection refused.

We should handle this exception and do something in response, but I'm not sure yet what that is. Current options include:

  1. Continue with the action and present a warning message on the UI that a webhook was not sent. (Not sure how we'd convey the failure to an API consumer though.)
  2. Abort the action with an error message (seems extreme).
  3. Maintain the current behavior of displaying an error page (after applying the change), but with more contextual help around fixing Redis.

I'm open to other suggestions.

Use Case

Provide a better user experience and recovery path in the event of a Redis failure.

Database Changes

None

External Dependencies

None

Originally created by @jeremystretch on GitHub (Feb 14, 2020). Originally assigned to: @jeremystretch on GitHub. ### Environment * Python version: 3.6.9 * NetBox version: 2.7.6 ### Proposed Functionality When NetBox attempts to enqueue a webhook and Redis is unreachable, an exception is raised: ``` File "/home/jstretch/.virtualenvs/netbox/lib/python3.6/site-packages/redis/connection.py", line 544, in connect raise ConnectionError(self._error_message(e)) redis.exceptions.ConnectionError: Error 111 connecting to localhost:6379. Connection refused. ``` We should handle this exception and do _something_ in response, but I'm not sure yet what that is. Current options include: 1) Continue with the action and present a warning message on the UI that a webhook was not sent. (Not sure how we'd convey the failure to an API consumer though.) 2) Abort the action with an error message (seems extreme). 3) Maintain the current behavior of displaying an error page (after applying the change), but with more contextual help around fixing Redis. I'm open to other suggestions. ### Use Case Provide a better user experience and recovery path in the event of a Redis failure. ### Database Changes None ### External Dependencies None
adam added the status: acceptedtype: feature labels 2025-12-29 18:27:46 +01:00
adam closed this issue 2025-12-29 18:27:46 +01:00
adam commented 2025-12-29 18:27:47 +01:00
Author
Owner
Copy Link

@sdktr commented on GitHub (Feb 20, 2020):

Implement 1 or 2 depending on a boolean set on the webhook?
allow_updates_on_webhook_failure
True -> 1
False -> 2

@sdktr commented on GitHub (Feb 20, 2020): Implement 1 or 2 depending on a boolean set on the webhook? `allow_updates_on_webhook_failure` True -> 1 False -> 2
adam commented 2025-12-29 18:27:47 +01:00
Author
Owner
Copy Link

@jeremystretch commented on GitHub (Feb 21, 2020):

I opted to go with option 1, because it conveys the need for attention to the user without disrupting the workflow. Option 2 seems needlessly harsh, and option 3 would be too disruptive and lead the user to question whether the action itself was successful.

Screenshot_2020-02-21 Devices - NetBox

@jeremystretch commented on GitHub (Feb 21, 2020): I opted to go with option 1, because it conveys the need for attention to the user without disrupting the workflow. Option 2 seems needlessly harsh, and option 3 would be too disruptive and lead the user to question whether the action itself was successful. ![Screenshot_2020-02-21 Devices - NetBox](https://user-images.githubusercontent.com/13487278/75076400-10331200-54ce-11ea-8e10-06f4bd68fb44.png)
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 status: accepted type: feature
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#3330
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?