Skip to content

Commit

Permalink
Merge pull request openshift#6366 from kyoto/monitoring-popup-wording
Browse files Browse the repository at this point in the history
Bug 1869942: Monitoring: Clarify popover help text
  • Loading branch information
openshift-merge-robot authored Aug 20, 2020
2 parents 69b0b98 + f61856d commit bd56117
Showing 1 changed file with 24 additions and 9 deletions.
33 changes: 24 additions & 9 deletions frontend/public/components/monitoring/alerting.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -282,17 +282,28 @@ const PopoverField: React.FC<{ body: React.ReactNode; label: string }> = ({ body
const alertStateHelp = (
<dl className="co-inline">
<dt>
<AlertStateIcon state={AlertStates.Firing} /> <strong>Firing: </strong>
<AlertStateIcon state={AlertStates.Pending} /> <strong>Pending: </strong>
</dt>
<dd>The alert condition is true for the duration of the timeout.</dd>
<dd>
The alert is active but is waiting for the duration that is specified in the alerting rule
before it fires.
</dd>
<dt>
<AlertStateIcon state={AlertStates.Pending} /> <strong>Pending: </strong>
<AlertStateIcon state={AlertStates.Firing} /> <strong>Firing: </strong>
</dt>
<dd>The alert condition is true, but the timeout has not been reached.</dd>
<dd>
The alert is firing because the alert condition is true and the optional `for` duration has
passed. The alert will continue to fire as long as the condition remains true.
</dd>
<dt>
<AlertStateIcon state={AlertStates.Silenced} /> <strong>Silenced: </strong>
</dt>
<dd>The alert is now silenced.</dd>
<dt></dt>
<dd>
The alert is now silenced for a defined time period. Silences temporarily mute alerts based on
a set of label selectors that you define. Notifications will not be sent for alerts that match
all the listed values or regular expressions.
</dd>
</dl>
);

Expand All @@ -303,14 +314,16 @@ const severityHelp = (
</dt>
<dd>
The condition that triggered the alert could have a critical impact. The alert requires
immediate attention when fired.
immediate attention when fired and is typically paged to an individual or to a critical
response team.
</dd>
<dt>
<SeverityIcon severity={AlertSeverity.Warning} /> <strong>Warning: </strong>
</dt>
<dd>
The alert provides a warning notification about something that might require attention in
order to prevent a problem from occurring.
order to prevent a problem from occurring. Warnings are typically routed to a ticketing system
for non-immediate review.
</dd>
<dt>
<SeverityIcon severity={AlertSeverity.Info} /> <strong>Info: </strong>
Expand All @@ -320,6 +333,7 @@ const severityHelp = (
<SeverityIcon severity={AlertSeverity.None} /> <strong>None: </strong>
</dt>
<dd>The alert has no defined severity.</dd>
<dd>You can also create custom severity definitions for user workload alerts.</dd>
</dl>
);

Expand All @@ -336,8 +350,9 @@ const sourceHelp = (
<strong>User: </strong>
</dt>
<dd>
User workload alerts relate to user-defined namespaces and are customizable. User workload
monitoring can be enabled post-installation to provide observability into your own services.
User workload alerts relate to user-defined namespaces. These alerts are user-created and are
customizable. User workload monitoring can be enabled post-installation to provide
observability into your own services.
</dd>
</dl>
);
Expand Down

0 comments on commit bd56117

Please sign in to comment.