Merge pull request #651 from nscuro/improve-notification-logging

Add alert option to log successful publishing
DependencyTrack · Nov 21, 2023 · 5bdcc9b · 5bdcc9b
2 parents a6679a5 + 54e2a84
commit 5bdcc9b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/src/i18n/locales/en.json b/src/i18n/locales/en.json
@@ -670,6 +670,8 @@
     "limit_to_tags": "Limit to Tags",
     "alert_created": "Alert created",
     "alert_deleted": "Alert deleted",
+    "alert_log_successful_publish": "Log successful publish",
+    "alert_log_successful_publish_help": "Emit a log message upon successful publishing of the alert to the destination, instead of only emitting logs when issues are encountered. Aids in debugging missing alerts, or making alert publishing auditable.",
     "change_password_next_login": "User must change password at next login",
     "password_never_expires": "Password never expires",
     "suspended": "Suspended",

diff --git a/src/views/administration/notifications/Alerts.vue b/src/views/administration/notifications/Alerts.vue
@@ -126,6 +126,9 @@
                     <b-form-group>
                       <c-switch id="notificationEnabled" color="primary" v-model="enabled" label v-bind="labelIcon"/>
                       {{ $t('admin.enabled') }}
+                      <br/>
+                      <c-switch id="notificationLogSuccessfulPublish" color="primary" v-model="logSuccessfulPublish" label v-bind="labelIcon" :title="$t('admin.alert_log_successful_publish_help')" />
+                      {{ $t('admin.alert_log_successful_publish') }}
                     </b-form-group>
                     <b-form-group id="fieldset-2" :label="this.$t('admin.publisher_class')" label-for="input-2">
                       <b-form-input id="input-2" v-model="publisherClass" disabled class="form-control disabled" readonly trim />
@@ -216,6 +219,7 @@
                   uuid: row.uuid,
                   name: row.name,
                   enabled: row.enabled,
+                  logSuccessfulPublish: row.logSuccessfulPublish,
                   notifyChildren: row.notifyChildren,
                   publisherClass: row.publisher.publisherClass,
                   notificationLevel: row.notificationLevel,
@@ -240,6 +244,9 @@
                 enabled() {
                   this.updateNotificationRule();
                 },
+                logSuccessfulPublish() {
+                  this.updateNotificationRule();
+                },
                 notifyChildren() {
                   this.updateNotificationRule();
                 },
@@ -282,6 +289,7 @@
                     uuid: this.uuid,
                     name: this.name,
                     enabled: this.enabled,
+                    logSuccessfulPublish: this.logSuccessfulPublish,
                     notifyChildren: this.notifyChildren,
                     notificationLevel: this.notificationLevel,
                     publisherConfig: JSON.stringify({ destination: this.destination, jiraTicketType: this.jiraTicketType }),