Add descriptions to alert types #81850

mikecote · 2020-10-27T20:09:31Z

In this PR, I'm adding a description to each alert type that is registered in the UI as well as making it required in TypeScript for any new alert type that gets created.

There's a few upcoming features that will start taking advantage of these:

New alert type selector in the create flyout (Alert flyout icons within "Select a trigger type" are not vertically aligned #67139)
Display the description in the alert flyout (Improve UX for finding documentation for each alert type #75548 (comment))

Note to codeowners

I gave it my best guess at how to describe each alert type. I'd like to have the description (and code) reviewed either to make sure the description accurate or to get feedback on a better suggestion. So far, starting every description with "Alert when" seems right. I will get @gchaps to help review these after your feedback.

Note for docs

From a technical perspective, the AlertTypeModel in the UI now requires via TypeScript a description property.

…t-type-descriptions

elasticmachine · 2020-10-28T15:22:56Z

Pinging @elastic/kibana-alerting-services (Team:Alerting Services)

shahzad31 · 2020-10-28T15:39:29Z

x-pack/plugins/uptime/common/translations.ts

@@ -32,4 +32,7 @@ export const MonitorStatusTranslations = {
  name: i18n.translate('xpack.uptime.alerts.monitorStatus.clientName', {
    defaultMessage: 'Uptime monitor status',
  }),
+  description: i18n.translate('xpack.uptime.alerts.monitorStatus.description', {
+    defaultMessage: 'Alert when the status of an Uptime monitor is down.',


i think this need a better copy, uptime monitor status alert also incorporate availability alert

so may be something like monitor is down or availability crosses set threshold?

help needed here @paulb-elastic @drewpost

Alert when your synthetic monitor is down or its availability breaches an availability threshold

cc @shahzad31

Thank you for the feedback! I went ahead and updated the description for this Uptime alert here: 3c83b62.

elasticmachine · 2020-10-28T15:39:34Z

Pinging @elastic/apm-ui (Team:apm)

elasticmachine · 2020-10-28T15:39:34Z

Pinging @elastic/uptime (Team:uptime)

chrisronline

LGTM for stack monitoring!

formgeist

Suggested some minor changes to the APM alert descriptions.

x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts

…t-type-descriptions

mikecote · 2020-11-02T19:57:53Z

@chrisronline @phillipb @formgeist thanks for making sure my descriptions were accurate. I got the descriptions reviewed by @gchaps and we slightly modified them. I could use another review 👍 for awareness.

mikecote · 2020-11-03T00:21:53Z

@shahzad31

thanks for making sure my descriptions were accurate. I got the descriptions reviewed by @gchaps and we slightly modified them. I could use another review 👍 for awareness.

Same for Uptime now, I just finished updating the copy 👍

phillipb

👍

chrisronline · 2020-11-03T14:22:26Z

x-pack/plugins/monitoring/common/constants.ts

+    description: i18n.translate(
+      'xpack.monitoring.alerts.elasticsearchVersionMismatch.description',
+      {
+        defaultMessage: 'Alert when the cluster has mutliple versions of Elasticsearch.',


Typo here with mutliple

chrisronline · 2020-11-03T14:23:11Z

x-pack/plugins/monitoring/common/constants.ts

  },
  [ALERT_LOGSTASH_VERSION_MISMATCH]: {
    label: i18n.translate('xpack.monitoring.alerts.logstashVersionMismatch.label', {
      defaultMessage: 'Logstash version mismatch',
    }),
+    description: i18n.translate('xpack.monitoring.alerts.logstashVersionMismatch.description', {
+      defaultMessage: 'Alert when the cluster has mutliple versions of Logstash.',


Typo here with mutliple

formgeist

LGTM 👍

…t-type-descriptions

chrisronline

LGTM!

* Initial attempt at adding descriptions to alert types * Fix typecheck failures * Fix i18n check * Fix failing jest test * Fix i18n check again * Apply changes for Uptime * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Fix jest test * Update geo threshold description * Update description of some alert types based on feedback from Gail * Update description of some alert types based on feedback from Gail * Fix i18n * Fix i18n * Fix ESLint * Update some copy * Update uptime alert description * Fix typos Co-authored-by: Casper Hübertz <casper@formgeist.com>

* Initial attempt at adding descriptions to alert types * Fix typecheck failures * Fix i18n check * Fix failing jest test * Fix i18n check again * Apply changes for Uptime * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Update x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Co-authored-by: Casper Hübertz <casper@formgeist.com> * Fix jest test * Update geo threshold description * Update description of some alert types based on feedback from Gail * Update description of some alert types based on feedback from Gail * Fix i18n * Fix i18n * Fix ESLint * Update some copy * Update uptime alert description * Fix typos Co-authored-by: Casper Hübertz <casper@formgeist.com> Co-authored-by: Casper Hübertz <casper@formgeist.com>

kibanamachine · 2020-11-09T19:54:42Z

💔 Build Failed

continuous-integration/kibana-ci/pull-request
Commit: 893d255
Pipeline Steps (look for red circles / failed steps)
Interpreting CI Failures

Failed CI Steps

Test Failures

X-Pack API Integration Tests.x-pack/test/api_integration/apis/management/rollup/rollup·js.apis management rollup jobs Index patterns should return the date, numeric and keyword fields when an index pattern matches indices

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has failed 1 times on tracked branches: https://dryrun

[00:00:00]       │
[00:00:00]         └-: apis
[00:00:00]           └-> "before all" hook
[00:04:06]           └-: management
[00:04:06]             └-> "before all" hook
[00:04:21]             └-: rollup
[00:04:21]               └-> "before all" hook
[00:04:21]               └-: jobs
[00:04:21]                 └-> "before all" hook
[00:04:21]                 └-: Index patterns
[00:04:21]                   └-> "before all" hook
[00:04:21]                   └-> should return the date, numeric and keyword fields when an index pattern matches indices
[00:04:21]                     └-> "before each" hook: global before each
[00:04:21]                     │ info [o.e.c.m.MetadataCreateIndexService] [kibana-ci-immutable-centos-tests-xxl-1604945402359657185] [xjljltdp-1604949928576] creating index, cause [api], templates [], shards [1]/[1]
[00:04:21]                     └- ✖ fail: apis management rollup jobs Index patterns should return the date, numeric and keyword fields when an index pattern matches indices
[00:04:21]                     │       Error: expected { doesMatchIndices: true,
[00:04:21]                     │   doesMatchRollupIndices: false,
[00:04:21]                     │   dateFields: [ 'testCreatedField' ],
[00:04:21]                     │   numericFields: [ '_doc_count', 'testTotalField' ],
[00:04:21]                     │   keywordFields: [ 'testTagField' ] } to sort of equal { dateFields: [ 'testCreatedField' ],
[00:04:21]                     │   keywordFields: [ 'testTagField' ],
[00:04:21]                     │   numericFields: [ 'testTotalField' ],
[00:04:21]                     │   doesMatchIndices: true,
[00:04:21]                     │   doesMatchRollupIndices: false }
[00:04:21]                     │       + expected - actual
[00:04:21]                     │ 
[00:04:21]                     │          "keywordFields": [
[00:04:21]                     │            "testTagField"
[00:04:21]                     │          ]
[00:04:21]                     │          "numericFields": [
[00:04:21]                     │       -    "_doc_count"
[00:04:21]                     │            "testTotalField"
[00:04:21]                     │          ]
[00:04:21]                     │        }
[00:04:21]                     │       
[00:04:21]                     │       at Assertion.assert (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:100:11)
[00:04:21]                     │       at Assertion.eql (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:244:8)
[00:04:21]                     │       at Context.it (test/api_integration/apis/management/rollup/rollup.js:48:25)
[00:04:21]                     │ 
[00:04:21]                     │

Stack Trace

{ Error: expected { doesMatchIndices: true,
  doesMatchRollupIndices: false,
  dateFields: [ 'testCreatedField' ],
  numericFields: [ '_doc_count', 'testTotalField' ],
  keywordFields: [ 'testTagField' ] } to sort of equal { dateFields: [ 'testCreatedField' ],
  keywordFields: [ 'testTagField' ],
  numericFields: [ 'testTotalField' ],
  doesMatchIndices: true,
  doesMatchRollupIndices: false }
    at Assertion.assert (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:100:11)
    at Assertion.eql (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:244:8)
    at Context.it (test/api_integration/apis/management/rollup/rollup.js:48:25)
  actual:
   '{\n  "dateFields": [\n    "testCreatedField"\n  ]\n  "doesMatchIndices": true\n  "doesMatchRollupIndices": false\n  "keywordFields": [\n    "testTagField"\n  ]\n  "numericFields": [\n    "_doc_count"\n    "testTotalField"\n  ]\n}',
  expected:
   '{\n  "dateFields": [\n    "testCreatedField"\n  ]\n  "doesMatchIndices": true\n  "doesMatchRollupIndices": false\n  "keywordFields": [\n    "testTagField"\n  ]\n  "numericFields": [\n    "testTotalField"\n  ]\n}',
  showDiff: true }

X-Pack API Integration Tests.x-pack/test/api_integration/apis/management/rollup/rollup·js.apis management rollup jobs Index patterns should return the date, numeric and keyword fields when an index pattern matches indices

Link to Jenkins

Standard Out

Failed Tests Reporter:
  - Test has not failed recently on tracked branches

[00:00:00]       │
[00:00:00]         └-: apis
[00:00:00]           └-> "before all" hook
[00:04:09]           └-: management
[00:04:09]             └-> "before all" hook
[00:04:24]             └-: rollup
[00:04:24]               └-> "before all" hook
[00:04:24]               └-: jobs
[00:04:24]                 └-> "before all" hook
[00:04:24]                 └-: Index patterns
[00:04:24]                   └-> "before all" hook
[00:04:24]                   └-> should return the date, numeric and keyword fields when an index pattern matches indices
[00:04:24]                     └-> "before each" hook: global before each
[00:04:24]                     │ info [o.e.c.m.MetadataCreateIndexService] [kibana-ci-immutable-centos-tests-xxl-1604945402359657185] [vhaklzeyzxr-1604948594464] creating index, cause [api], templates [], shards [1]/[1]
[00:04:24]                     └- ✖ fail: apis management rollup jobs Index patterns should return the date, numeric and keyword fields when an index pattern matches indices
[00:04:24]                     │       Error: expected { doesMatchIndices: true,
[00:04:24]                     │   doesMatchRollupIndices: false,
[00:04:24]                     │   dateFields: [ 'testCreatedField' ],
[00:04:24]                     │   numericFields: [ '_doc_count', 'testTotalField' ],
[00:04:24]                     │   keywordFields: [ 'testTagField' ] } to sort of equal { dateFields: [ 'testCreatedField' ],
[00:04:24]                     │   keywordFields: [ 'testTagField' ],
[00:04:24]                     │   numericFields: [ 'testTotalField' ],
[00:04:24]                     │   doesMatchIndices: true,
[00:04:24]                     │   doesMatchRollupIndices: false }
[00:04:24]                     │       + expected - actual
[00:04:24]                     │ 
[00:04:24]                     │          "keywordFields": [
[00:04:24]                     │            "testTagField"
[00:04:24]                     │          ]
[00:04:24]                     │          "numericFields": [
[00:04:24]                     │       -    "_doc_count"
[00:04:24]                     │            "testTotalField"
[00:04:24]                     │          ]
[00:04:24]                     │        }
[00:04:24]                     │       
[00:04:24]                     │       at Assertion.assert (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:100:11)
[00:04:24]                     │       at Assertion.eql (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:244:8)
[00:04:24]                     │       at Context.it (test/api_integration/apis/management/rollup/rollup.js:48:25)
[00:04:24]                     │ 
[00:04:24]                     │

Stack Trace

{ Error: expected { doesMatchIndices: true,
  doesMatchRollupIndices: false,
  dateFields: [ 'testCreatedField' ],
  numericFields: [ '_doc_count', 'testTotalField' ],
  keywordFields: [ 'testTagField' ] } to sort of equal { dateFields: [ 'testCreatedField' ],
  keywordFields: [ 'testTagField' ],
  numericFields: [ 'testTotalField' ],
  doesMatchIndices: true,
  doesMatchRollupIndices: false }
    at Assertion.assert (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:100:11)
    at Assertion.eql (/dev/shm/workspace/parallel/23/kibana/packages/kbn-expect/expect.js:244:8)
    at Context.it (test/api_integration/apis/management/rollup/rollup.js:48:25)
  actual:
   '{\n  "dateFields": [\n    "testCreatedField"\n  ]\n  "doesMatchIndices": true\n  "doesMatchRollupIndices": false\n  "keywordFields": [\n    "testTagField"\n  ]\n  "numericFields": [\n    "_doc_count"\n    "testTotalField"\n  ]\n}',
  expected:
   '{\n  "dateFields": [\n    "testCreatedField"\n  ]\n  "doesMatchIndices": true\n  "doesMatchRollupIndices": false\n  "keywordFields": [\n    "testTagField"\n  ]\n  "numericFields": [\n    "testTotalField"\n  ]\n}',
  showDiff: true }

Metrics [docs]

Async chunks

Total size of all lazy-loaded chunks that will be downloaded as the user navigates the app

id	before	after	diff
`monitoring`	964.5KB	965.0KB	+467.0B

Page load bundle

Size of the bundles that are downloaded on every page load. Target size is below 100kb

id	before	after	diff
`apm`	47.3KB	48.2KB	+884.0B
`infra`	172.7KB	173.2KB	+572.0B
`monitoring`	33.1KB	35.5KB	+2.4KB
`triggersActionsUi`	131.9KB	132.4KB	+510.0B
`uptime`	23.9KB	24.7KB	+834.0B
total			+5.1KB

Saved Objects .kibana field count

Every field in each saved object type adds overhead to Elasticsearch. Kibana needs to keep the total field count below Elasticsearch's default limit of 1000 fields. Only specify field mappings for the fields you wish to search on or query. See https://www.elastic.co/guide/en/kibana/master/development-plugin-saved-objects.html#_mappings

id	before	after	diff
`_doc_count`	-	1	+1

History

💚 Build #85535 succeeded 893d255
💚 Build #85416 succeeded 0b13c81
💚 Build #85342 succeeded dd76573
💚 Build #85211 succeeded a7cd742
💔 Build #85174 failed e502129

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Initial attempt at adding descriptions to alert types

05da04a

mikecote added Feature:Alerting v8.0.0 release_note:skip Skip the PR/issue when compiling release notes Team:ResponseOps Label for the ResponseOps team (formerly the Cases and Alerting teams) v7.11.0 labels Oct 27, 2020

mikecote self-assigned this Oct 27, 2020

mikecote added 5 commits October 28, 2020 08:21

Fix typecheck failures

61d5aa3

Fix i18n check

cf14a66

Fix failing jest test

0b1f29e

Merge branch 'master' of github.com:elastic/kibana into alerting/aler…

cf1a1dd

…t-type-descriptions

Fix i18n check again

082f0f2

mikecote mentioned this pull request Oct 28, 2020

Improve UX for finding documentation for each alert type #75548

Closed

mikecote marked this pull request as ready for review October 28, 2020 15:22

mikecote requested review from a team as code owners October 28, 2020 15:22

mikecote requested a review from a team October 28, 2020 15:22

mikecote requested a review from a team as a code owner October 28, 2020 15:22

shahzad31 reviewed Oct 28, 2020

View reviewed changes

botelastic bot added Team:APM All issues that need APM UI Team support Team:Uptime - DEPRECATED Synthetics & RUM sub-team of Application Observability labels Oct 28, 2020

chrisronline approved these changes Oct 28, 2020

View reviewed changes

formgeist approved these changes Oct 29, 2020

View reviewed changes

x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Outdated Show resolved Hide resolved

x-pack/plugins/apm/public/components/alerting/register_apm_alerts.ts Outdated Show resolved Hide resolved

mikecote added 2 commits October 29, 2020 09:55

Merge branch 'master' of github.com:elastic/kibana into alerting/aler…

19bf4b3

…t-type-descriptions

Apply changes for Uptime

3c83b62

mikecote added 7 commits November 2, 2020 08:11

Merge with master

4791ca6

Update description of some alert types based on feedback from Gail

0973835

Update description of some alert types based on feedback from Gail

0fcc567

Fix i18n

a16191b

Fix i18n

e502129

Fix ESLint

a7cd742

Update some copy

dd76573

mikecote requested review from chrisronline, phillipb and formgeist November 2, 2020 19:56

Update uptime alert description

0b13c81

mikecote requested a review from shahzad31 November 3, 2020 00:21

phillipb approved these changes Nov 3, 2020

View reviewed changes

shahzad31 approved these changes Nov 3, 2020

View reviewed changes

chrisronline suggested changes Nov 3, 2020

View reviewed changes

formgeist approved these changes Nov 3, 2020

View reviewed changes

mikecote added 2 commits November 3, 2020 10:17

Merge branch 'master' of github.com:elastic/kibana into alerting/aler…

5f1abc7

…t-type-descriptions

Fix typos

893d255

mikecote requested a review from chrisronline November 3, 2020 15:18

chrisronline approved these changes Nov 3, 2020

View reviewed changes

mikecote merged commit eb43158 into elastic:master Nov 3, 2020

mikecote mentioned this pull request Nov 3, 2020

[7.x] Add descriptions to alert types (#81850) #82481

Merged

mikecote added the needs_docs label Nov 9, 2020

mikecote removed the needs_docs label Feb 23, 2021

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add descriptions to alert types #81850

Add descriptions to alert types #81850

mikecote commented Oct 27, 2020 •

edited

Loading

elasticmachine commented Oct 28, 2020

shahzad31 Oct 28, 2020

drewpost Oct 29, 2020

mikecote Oct 29, 2020

elasticmachine commented Oct 28, 2020

elasticmachine commented Oct 28, 2020

chrisronline left a comment

formgeist left a comment

mikecote commented Nov 2, 2020

mikecote commented Nov 3, 2020

phillipb left a comment

chrisronline Nov 3, 2020

chrisronline Nov 3, 2020

formgeist left a comment

chrisronline left a comment

kibanamachine commented Nov 9, 2020

Standard Out

Stack Trace

Standard Out

Stack Trace

Add descriptions to alert types #81850

Add descriptions to alert types #81850

Conversation

mikecote commented Oct 27, 2020 • edited Loading

Note to codeowners

Note for docs

elasticmachine commented Oct 28, 2020

shahzad31 Oct 28, 2020

Choose a reason for hiding this comment

drewpost Oct 29, 2020

Choose a reason for hiding this comment

mikecote Oct 29, 2020

Choose a reason for hiding this comment

elasticmachine commented Oct 28, 2020

elasticmachine commented Oct 28, 2020

chrisronline left a comment

Choose a reason for hiding this comment

formgeist left a comment

Choose a reason for hiding this comment

mikecote commented Nov 2, 2020

mikecote commented Nov 3, 2020

phillipb left a comment

Choose a reason for hiding this comment

chrisronline Nov 3, 2020

Choose a reason for hiding this comment

chrisronline Nov 3, 2020

Choose a reason for hiding this comment

formgeist left a comment

Choose a reason for hiding this comment

chrisronline left a comment

Choose a reason for hiding this comment

kibanamachine commented Nov 9, 2020

💔 Build Failed

Failed CI Steps

Test Failures

Standard Out

Stack Trace

Standard Out

Stack Trace

Metrics [docs]

Async chunks

Page load bundle

Saved Objects .kibana field count

History

mikecote commented Oct 27, 2020 •

edited

Loading