docs(notifications): document the Connector Health Warning notification - #15646
Open
svader0 wants to merge 1 commit into
Open
docs(notifications): document the Connector Health Warning notification#15646svader0 wants to merge 1 commit into
svader0 wants to merge 1 commit into
Conversation
A connector whose runs fail, or whose tool stops returning records, is silent outside the connectors page. Document the notification that tells you, what each message covers, and how often it arrives.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Documents the Connector Health Warning notification, which is new in Pro.
A connector that stops working is silent. Its runs fail against the vendor, or its tool stops returning the records it used to return, and nothing in DefectDojo raises an error. The only sign is on the Upstream Connectors page. The new notification is the message that reaches a user who is not looking at that page.
Two files change:
admin/notifications/about_notifications.mdgets a Connector Health Notifications (Pro) section, matching the pattern the review-request and work-assignment sections already use. It says what the two messages cover, how often they arrive, and where to set the channel.connectors/upstream/manage_operations.mdgets a short pointer at the end of the page, because that is where a user reads about failed operations.No screenshots. The section describes the behavior in text.
Note for whoever merges: PR #15634 adds a "When a Connector runs but imports nothing" section to
manage_operations.md. It edits the top of that file and this one appends to the bottom, so the two do not conflict. Both belong to the same release.