Storage System User Alert - Revision history

Qadmin: Provenance footer: use the three-component release (6.9.0); build counters and branch tags do not survive to a release (wiki-docs rule 13)

2026-09-03T00:44:33Z

Provenance footer: use the three-component release (6.9.0); build counters and branch tags do not survive to a release (wiki-docs rule 13)

← Older revision		Revision as of 00:44, 3 September 2026
Line 37:		Line 37:

	----		----
	<small>''Verified against QuantaStor 6.9.''</small>		<small>''Verified against QuantaStor 6.9.0.''</small>

Qadmin: Re-fit screenshot widths to half the captured size (capped at 800px) so 2x captures display at their true on-screen size (wiki-docs rule 5)

2026-09-03T00:30:00Z

Re-fit screenshot widths to half the captured size (capped at 800px) so 2x captures display at their true on-screen size (wiki-docs rule 5)

← Older revision		Revision as of 00:30, 3 September 2026
Line 1:		Line 1:
	[[File:alertmgr_test_alert.png\|thumb\|right\|~~800px~~\|Send User Generated Alert dialog. It takes a message and a severity -- nothing else.]]		[[File:alertmgr_test_alert.png\|thumb\|right\|328px\|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:		The '''Send User Generated Alert''' feature raises an alert by hand, through every alerting mechanism the Storage Grid has configured. Its two uses are:

Qadmin: Add the provenance footer recording the release this page was verified against (wiki-docs rule 13)

2026-09-03T00:26:57Z

Add the provenance footer recording the release this page was verified against (wiki-docs rule 13)

← Older revision		Revision as of 00:26, 3 September 2026
Line 35:		Line 35:
	{{Template:ReturnToWebGuide}}		{{Template:ReturnToWebGuide}}
	[[Category:QuantaStor6]] [[Category:WebUI Dialog]]		[[Category:QuantaStor6]] [[Category:WebUI Dialog]]

			----
			<small>''Verified against QuantaStor 6.9.''</small>

Qadmin: Use Template:Code for inline code - dark blue on a light blue ground, matching the Navigation block, with the styling kept in one place

2026-09-02T22:46:06Z

Use Template:Code for inline code - dark blue on a light blue ground, matching the Navigation block, with the styling kept in one place

← Older revision		Revision as of 22:46, 2 September 2026
Line 23:		Line 23:
	'''Send the test at "Warning" or higher.''' QuantaStor deliberately does not forward '''Info''' level alerts to the ITSM webhook modules, so an Info level test will never reach Slack, PagerDuty, Teams and the like -- making a working integration look broken. Info level alerts are still delivered by email and recorded in the audit log.		'''Send the test at "Warning" or higher.''' QuantaStor deliberately does not forward '''Info''' level alerts to the ITSM webhook modules, so an Info level test will never reach Slack, PagerDuty, Teams and the like -- making a working integration look broken. Info level alerts are still delivered by email and recorded in the audit log.

	'''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.		'''The alert is real.''' It is delivered through live mechanisms and recorded in the audit log at {{Code\|1=/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:		The same thing can be done from the CLI:

Qadmin: Use Template:Navigation for breadcrumbs - renders as a distinct block, and → instead of --> (proper arrow, source stays ASCII)

2026-09-02T22:31:29Z

Use Template:Navigation for breadcrumbs - renders as a distinct block, and → instead of --> (proper arrow, source stays ASCII)

← Older revision		Revision as of 22:31, 2 September 2026
Line 6:		Line 6:
	* '''Notifying administrators of something QuantaStor cannot detect''' -- an upcoming maintenance window, for example -- through the channels they already watch.		* '''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)''		{{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.		The '''Generate Test Alert''' button is available from every tab of the Alert Manager dialog.

Qadmin: Reduce the font size one step in

 blocks - a monospace change alone does not separate code from prose clearly enough

2026-09-02T21:55:21Z

Reduce the font size one step in <pre> blocks - a monospace change alone does not separate code from prose clearly enough

← Older revision		Revision as of 21:55, 2 September 2026
Line 27:		Line 27:
	The same thing can be done from the CLI:		The same thing can be done from the CLI:

	<pre>		<pre style="font-size: smaller">
	qs alert-raise --message="Scheduled maintenance window starting" --severity=warning		qs alert-raise --message="Scheduled maintenance window starting" --severity=warning
	</pre>		</pre>

Qadmin: Right-justify screenshots per the documentation conventions (thumb|right|800px) - a centred 800px block pushes the prose down and reads worse than a right-floated thumbnail

2026-09-02T21:41:37Z

Right-justify screenshots per the documentation conventions (thumb|right|800px) - a centred 800px block pushes the prose down and reads worse than a right-floated thumbnail

← Older revision		Revision as of 21:41, 2 September 2026
Line 1:		Line 1:
	[[File:alertmgr_test_alert.png\|thumb\|~~center~~\|800px\|Send User Generated Alert dialog. It takes a message and a severity -- nothing else.]]		[[File:alertmgr_test_alert.png\|thumb\|right\|800px\|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:		The '''Send User Generated Alert''' feature raises an alert by hand, through every alerting mechanism the Storage Grid has configured. Its two uses are:

Qadmin: Unwrap hard-wrapped prose lines - MediaWiki collapses a single newline inside a paragraph, so the wrapping had no effect on rendering and was inconsistent with the rest of the wiki. Rendered output is unchanged.

2026-09-02T18:21:58Z

Unwrap hard-wrapped prose lines - MediaWiki collapses a single newline inside a paragraph, so the wrapping had no effect on rendering and was inconsistent with the rest of the wiki. Rendered output is unchanged.

← Older revision		Revision as of 18:21, 2 September 2026
Line 1:		Line 1:
	[[File:alertmgr_test_alert.png\|thumb\|center\|800px\|Send User Generated Alert dialog. It takes a message and a severity -- nothing else.]]		[[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 raises an alert by hand, through		The '''Send User Generated Alert''' feature raises an alert by hand, through every alerting mechanism the Storage Grid has configured. Its two uses are:
	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.		* '''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.
Line 9:		Line 8:
	'''Navigation:''' Storage Management --> ''select a Storage System'' --> Alert Manager ''(toolbar)'' --> Generate Test Alert ''(button)''		'''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		The '''Generate Test Alert''' button is available from every tab of the Alert Manager dialog.
	Manager dialog.

	== Fields ==		== Fields ==
Line 17:		Line 15:
	* '''Severity''' -- the level the alert is raised at: '''Critical''', '''Error''', '''Warning''', or '''Info'''.		* '''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		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.
	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 ==		== Notes ==

	'''Save your settings first.''' Press '''OK''' or '''Apply''' on the 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.
	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.

	'''Send the test at "Warning" or higher.''' QuantaStor deliberately does not		'''Send the test at "Warning" or higher.''' QuantaStor deliberately does not forward '''Info''' level alerts to the ITSM webhook modules, so an Info level test will never reach Slack, PagerDuty, Teams and the like -- making a working integration look broken. Info level alerts are still delivered by email and recorded in the audit log.
	forward '''Info''' level alerts to the ITSM webhook modules, so an Info level
	test will never reach Slack, PagerDuty, Teams and the like -- making a working
	integration look broken. Info level alerts are still delivered by email and
	recorded in the audit log.

	'''The alert is real.''' It is delivered through live mechanisms and recorded in		'''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.
	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.

	The same thing can be done from the CLI:		The same thing can be done from the CLI:
Line 45:		Line 31:
	</pre>		</pre>

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

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

Qadmin: QSTOR-12340: correct the Info-level note - QuantaStor withholds Info from ITSM webhooks, so an Info test never reaches them

2026-09-02T06:25:55Z

QSTOR-12340: correct the Info-level note - QuantaStor withholds Info from ITSM webhooks, so an Info test never reaches them

← Older revision		Revision as of 06:25, 2 September 2026
Line 29:		Line 29:
	fail for reasons that have nothing to do with the settings themselves.		fail for reasons that have nothing to do with the settings themselves.

	'''~~Choose~~ the ~~severity deliberately when testing.''' Send~~ at ~~'''~~Warning''' ~~as a~~		'''Send the test at "Warning" or higher.''' QuantaStor deliberately does not
	~~first check. Some ITSM integrations and user subscriptions filter~~ '''Info'''		forward '''Info''' level alerts to the ITSM webhook modules, so an Info level
	level ~~events~~, so an Info-level ~~test can appear to have failed when it was simply~~		test will never reach Slack, PagerDuty, Teams and the like -- making a working
	~~filtered as configured~~.		integration look broken. Info level alerts are still delivered by email and
			recorded in the audit log.

	'''The alert is real.''' It is delivered through live mechanisms and recorded in		'''The alert is real.''' It is delivered through live mechanisms and recorded in

Qadmin: 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

2026-09-02T06:13:54Z

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

← Older revision		Revision as of 06:13, 2 September 2026
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]]