Storage System User Alert: Difference between revisions

From OSNEXUS Online Documentation Site
Jump to navigation Jump to search
← Older editNewer edit →
VisualWikitext
mNo edit summary
m QSTOR-12340: rewrite from the actual dialog - it has only Message and Severity; the page previously described recipient selection, a subject field, scheduling and response monitoring, none of which exist
Line 1: Line 1:
[[File:Send User Alert.jpg|512px|thumb|This dialogue is used to send a test alert and verify the Alert Manager settings are correct. Enter in a sample message, select a delivery priority, and press ok.]]
[[File:alertmgr_test_alert.png|thumb|center|800px|Send User Generated Alert dialog. It takes a message and a severity -- nothing else.]]


The "Send User Generated Alert" feature in QuantaStor allows administrators to create and send custom alerts to notify users or administrators about specific events or conditions within the storage system. This feature is useful for communicating important information that might not be automatically covered by system-generated alerts.
The '''Send User Generated Alert''' feature raises an alert by hand, through
every alerting mechanism the Storage Grid has configured. Its two uses are:


''Note: you must first save your settings by pressing the OK button on the Alert Manager window before sending a Test Alert.''
* '''Verifying the Alert Manager.''' After entering SMTP settings, an ITSM webhook, or SNMP credentials, send an alert and confirm it arrives. This is the fastest end-to-end check that alerting actually works.
* '''Notifying administrators of something QuantaStor cannot detect''' -- an upcoming maintenance window, for example -- through the channels they already watch.


Here’s why you might use this feature:
'''Navigation:''' Storage Management --> ''select a Storage System'' --> Alert Manager ''(toolbar)'' --> Generate Test Alert ''(button)''


*Custom Notifications: Create alerts for specific situations or conditions that are unique to your environment or operational needs. For example, notifying users about planned maintenance or specific configuration changes.
The '''Generate Test Alert''' button is available from every tab of the Alert
Manager dialog.


*Incident Reporting: Inform users or administrators about incidents or issues that require immediate attention, such as a suspected security breach or a detected anomaly that needs investigation.
== Fields ==


*Operational Updates: Keep relevant personnel informed about operational updates, such as changes to storage policies, the addition of new storage resources, or updates to system configurations.
* '''Message''' -- the alert text. This is the body that reaches every configured destination.
* '''Severity''' -- the level the alert is raised at: '''Critical''', '''Error''', '''Warning''', or '''Info'''.


*Compliance and Auditing: Send alerts to ensure compliance with regulatory requirements by notifying stakeholders about specific actions taken within the system, such as data access events or security audits.
There are no other fields. In particular the alert goes to '''all''' configured
destinations -- there is no per-alert recipient selection, no subject line, and
no scheduling. Who receives it is determined by the Alert Manager's configured
mechanisms and by each user's alert subscriptions, not by this dialog.


*User Instructions: Provide users with instructions or guidance related to the use of the storage system, such as new procedures, best practices, or reminders about system usage policies.
== Notes ==


Steps typically involved in sending a user-generated alert:
'''Save your settings first.''' Press '''OK''' or '''Apply''' on the Alert
Manager dialog '''before''' sending a test alert. Unsaved SMTP or webhook
settings are not used for the test, so a test sent against unsaved settings can
fail for reasons that have nothing to do with the settings themselves.


*Create Alert: Use the QuantaStor interface to create a new alert. This involves specifying the content of the alert, including the message, subject, and any relevant details.
'''Choose the severity deliberately when testing.''' Send at '''Warning''' as a
first check. Some ITSM integrations and user subscriptions filter '''Info'''
level events, so an Info-level test can appear to have failed when it was simply
filtered as configured.


*Specify Recipients: Select the users or groups who should receive the alert. This ensures that the right people are informed.
'''The alert is real.''' It is delivered through live mechanisms and recorded in
the audit log at <code>/var/log/qs/qs_audit.log</code> like any other alert.
Sending one at '''Critical''' will page whoever is on call.


*Send Alert: Trigger the alert to be sent immediately or schedule it for a specific time, depending on the nature of the message.
The same thing can be done from the CLI:
 
*Monitor and Follow-Up: After sending the alert, monitor any responses or actions taken in response to the alert and follow up as necessary to ensure the issue or notification is appropriately addressed.
 
Overall, the purpose of the "Send User Generated Alert" feature in QuantaStor is to provide administrators with a flexible tool for communicating important information to users and other stakeholders, enhancing the overall management and operation of the storage system through timely and relevant notifications.
 
 
 
'''Navigation:''' Storage Management --> Storage System --> Storage Systems --> Alert Manager (dialog) --> Generate Test Alert ''(button)''


<pre>
qs alert-raise --message="Scheduled maintenance window starting" --severity=warning
</pre>


For the full alerting configuration see
[[Call-home / Alerting|Alert Manager / Call-home Alerting]].


{{Template:ReturnToWebGuide}}
{{Template:ReturnToWebGuide}}
[[Category:QuantaStor6]]
[[Category:QuantaStor6]]
[[Category:WebUI Dialog]]
[[Category:WebUI Dialog]]

Revision as of 06:13, 2 September 2026

Send User Generated Alert dialog. It takes a message and a severity -- nothing else.

The Send User Generated Alert feature raises an alert by hand, through every alerting mechanism the Storage Grid has configured. Its two uses are:

  • Verifying the Alert Manager. After entering SMTP settings, an ITSM webhook, or SNMP credentials, send an alert and confirm it arrives. This is the fastest end-to-end check that alerting actually works.
  • Notifying administrators of something QuantaStor cannot detect -- an upcoming maintenance window, for example -- through the channels they already watch.

Navigation: Storage Management --> select a Storage System --> Alert Manager (toolbar) --> Generate Test Alert (button)

The Generate Test Alert button is available from every tab of the Alert Manager dialog.

Fields

  • Message -- the alert text. This is the body that reaches every configured destination.
  • Severity -- the level the alert is raised at: Critical, Error, Warning, or Info.

There are no other fields. In particular the alert goes to all configured destinations -- there is no per-alert recipient selection, no subject line, and no scheduling. Who receives it is determined by the Alert Manager's configured mechanisms and by each user's alert subscriptions, not by this dialog.

Notes

Save your settings first. Press OK or Apply on the Alert Manager dialog before sending a test alert. Unsaved SMTP or webhook settings are not used for the test, so a test sent against unsaved settings can fail for reasons that have nothing to do with the settings themselves.

Choose the severity deliberately when testing. Send at Warning as a first check. Some ITSM integrations and user subscriptions filter Info level events, so an Info-level test can appear to have failed when it was simply filtered as configured.

The alert is real. It is delivered through live mechanisms and recorded in the audit log at /var/log/qs/qs_audit.log like any other alert. Sending one at Critical will page whoever is on call.

The same thing can be done from the CLI: 

qs alert-raise --message="Scheduled maintenance window starting" --severity=warning

For the full alerting configuration see Alert Manager / Call-home Alerting.

Return to Using the Web Interface

Retrieved from "https://wiki.osnexus.com/index.php?title=Storage_System_User_Alert&oldid=27234"