Commit graph

65 commits

Author SHA1 Message Date
Kibana Machine
77d96eba76
[8.13] [DOCS] Add description for untracked alert status (#176974) (#180097) 2024-04-04 16:45:51 -07:00
Kibana Machine
254a23c737
[8.13] [DOCS] Add alert creation delay in Stack rules (#178461) (#178517)
# Backport

This will backport the following commits from `main` to `8.13`:
- [[DOCS] Add alert creation delay in Stack rules
(#178461)](https://github.com/elastic/kibana/pull/178461)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-03-12T14:57:34Z","message":"[DOCS]
Add alert creation delay in Stack rules
(#178461)","sha":"0c6701d4a78e437dd7f31c8dd72ef68d24f50bc3","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Feature:Alerting","release_note:skip","Team:ResponseOps","docs","v8.13.0","v8.14.0"],"title":"[DOCS]
Add alert creation delay in Stack
rules","number":178461,"url":"https://github.com/elastic/kibana/pull/178461","mergeCommit":{"message":"[DOCS]
Add alert creation delay in Stack rules
(#178461)","sha":"0c6701d4a78e437dd7f31c8dd72ef68d24f50bc3"}},"sourceBranch":"main","suggestedTargetBranches":["8.13"],"targetPullRequestStates":[{"branch":"8.13","label":"v8.13.0","branchLabelMappingKey":"^v(\\d+).(\\d+).\\d+$","isSourceBranch":false,"state":"NOT_CREATED"},{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/178461","number":178461,"mergeCommit":{"message":"[DOCS]
Add alert creation delay in Stack rules
(#178461)","sha":"0c6701d4a78e437dd7f31c8dd72ef68d24f50bc3"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2024-03-12 15:21:36 +00:00
Kibana Machine
1eab6677ee
[8.13] [DOCS] Improve tracking containment rule (#176979) (#177533)
# Backport

This will backport the following commits from `main` to `8.13`:
- [[DOCS] Improve tracking containment rule
(#176979)](https://github.com/elastic/kibana/pull/176979)

<!--- Backport version: 9.4.3 -->

### Questions ?
Please refer to the [Backport tool
documentation](https://github.com/sqren/backport)

<!--BACKPORT [{"author":{"name":"Lisa
Cawley","email":"lcawley@elastic.co"},"sourceCommit":{"committedDate":"2024-02-22T01:15:14Z","message":"[DOCS]
Improve tracking containment rule
(#176979)","sha":"ec5c7a402a328507a44a2946d7fbef9314118bdf","branchLabelMapping":{"^v8.14.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["Team:Presentation","Feature:Alerting","release_note:skip","Team:ResponseOps","docs","backport:prev-minor","v8.14.0"],"title":"[DOCS]
Improve tracking containment
rule","number":176979,"url":"https://github.com/elastic/kibana/pull/176979","mergeCommit":{"message":"[DOCS]
Improve tracking containment rule
(#176979)","sha":"ec5c7a402a328507a44a2946d7fbef9314118bdf"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.14.0","branchLabelMappingKey":"^v8.14.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/176979","number":176979,"mergeCommit":{"message":"[DOCS]
Improve tracking containment rule
(#176979)","sha":"ec5c7a402a328507a44a2946d7fbef9314118bdf"}}]}]
BACKPORT-->

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2024-02-21 19:29:48 -07:00
Lisa Cawley
797694df26
[Response Ops][Alerting] Edit text in Elasticsearch query rule and index threshold rule (#171896) 2023-11-28 17:37:29 -07:00
Lisa Cawley
45d0e32244
[DOCS] ES|QL in Elasticsearch query rules (#170291) 2023-11-03 13:26:49 -07:00
Lisa Cawley
27db507202
[DOCS] Rule visibility details for Elasticsearch query rules (#170072) 2023-10-30 08:40:58 -07:00
Lisa Cawley
d871474d19
[DOCS] Alerts-as-data for index threshold rules (#169049) 2023-10-17 07:33:37 -07:00
Lisa Cawley
3151aad37b
[DOCS] Automate screenshots for Elasticsearch query rule actions (#164794) 2023-09-07 12:16:10 -07:00
Nathan Reese
118ea87a08
[maps][alerting] fix ES query rule boundary field changed when editing the rule (#165155)
Fixes https://github.com/elastic/kibana/issues/163959

While digging into the original issue, it was determined that the
existing components were unsalvageable. Fixing all of the issues would
have required more work than just starting over. Problems with original
components include:
1) updating rule state on component load. This is the cause of the
reported bug.
2) lack of loading state when performing async tasks, like loading data
views.
3) not displaying validation errors. When users clicked "save" with
missing configuration, no UI notifications were displayed
4) Heavy use of EuiExpression made it impossible to view all
configuration in a single time

Now, geo containment form:
1) Only updates rule state when users interact with inputs.
2) Displays loading state when performing async tasks, like loading data
views.
3) Displays validation errors
4) Has a simpler UI that allows users to see all configuration
information at the same time.

<img width="300" alt="Screen Shot 2023-08-30 at 5 34 00 PM"
src="65abfa5d-6c8e-45a9-b69f-cc07f5be7184">

<img width="300" alt="Screen Shot 2023-08-30 at 5 34 48 PM"
src="63b5af12-7104-43ae-a836-0236cf9d1e98">

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-09-06 12:18:54 -06:00
Lisa Cawley
154ca404d0
[DOCS] Automate Elasticsearch query rule screenshots (#164127) 2023-08-23 11:41:44 -07:00
Lisa Cawley
bd6d65591a
[DOCS] Add conditional actions to Observability rule screenshots (#162284) 2023-08-14 11:16:39 -07:00
Lisa Cawley
aa4fbc14a9
[DOCS] Add example of a rule with errored actions (#162368) 2023-07-24 09:00:06 -07:00
Lisa Cawley
5bc6faac50
[DOCS] Refresh rule action variable screenshots (#162098) 2023-07-19 08:31:46 -07:00
Lisa Cawley
1b71d2ca3c
[DOCS] Maintenance window column in alerts tables (#158125) 2023-05-23 10:49:18 -07:00
Patrick Mueller
120fa44afd
[ResponseOps][docs] add docs for new mustache lambdas and asJSON for array (#155417)
resolves: https://github.com/elastic/kibana/issues/155408

## Summary

adds doc for function added in [adds mustache lambdas and
array.asJSON](https://github.com/elastic/kibana/pull/150572)
2023-05-14 14:39:25 -04:00
Lisa Cawley
fb68f2075a
[DOCS] Automate two rule management screenshots (#155566) 2023-04-25 08:11:22 -07:00
Lisa Cawley
a0aae1aa23
[DOCS] Automate rule-flyout-rule-conditions.png (#155461) 2023-04-21 07:51:28 -07:00
Lisa Cawley
2b9be70f84
[DOCS] Refresh rule detail screenshots (#153705) 2023-03-28 12:08:15 -07:00
Lisa Cawley
bd50903109
[DOCS] Add alert flapping and rule setting details (#153605) 2023-03-24 09:22:20 -07:00
Lisa Cawley
cc11df727f
[DOCS] Automate screenshots in tracking containment rule (#153406) 2023-03-22 07:51:16 -07:00
Lisa Cawley
b6cff1ad72
[DOCS] Automate rule-types-index-threshold-example-alerts.png (#152618) 2023-03-07 11:43:49 -05:00
Lisa Cawley
0c60d8edb7
[DOCS] Refresh index threshold rule screenshots (#152310) 2023-03-02 07:46:19 -08:00
Lisa Cawley
130d2a7a7c
[DOCS] Add alert summaries to overview (#151817) 2023-02-27 12:51:15 -05:00
Lisa Cawley
b37258e19c
[DOCS] Create and manage rule action frequencies (#150957) 2023-02-23 13:16:46 -08:00
Lisa Cawley
4e11ef1b6b
[ResponseOps] Automate screenshots for new rule statuses (#147492)
Co-authored-by: Brandon Kobel <brandon.kobel@gmail.com>
2023-01-04 07:21:00 -05:00
Lisa Cawley
c99f40f4b2
[DOCS] Refresh alerting troubleshooting (#147633) 2022-12-15 15:15:33 -08:00
Ying Mao
fdf4dea9bd
[Response Ops][Alerting] Adding group by options to ES query rule type (#144689)
Resolves https://github.com/elastic/kibana/issues/89481

## Summary

Adds group by options to the ES query rule type, both DSL and KQL
options. This is the same limited group by options that are offered in
the index threshold rule type so I used the same UI components and rule
parameter names. I moved some aggregation building code to `common` so
they could be reused. All existing ES query rules are migrated to be
`count over all` rules.

## To Verify

* Create the following types of rules and verify they work as expected.
Verify for both DSL query and KQL query
* `count over all` rule - this should run the same as before, where it
counts the number of documents that matches the query and applies the
threshold condition to that value. `{{context.hits}}` is all the
documents that match the query if the threshold condition is met.
* `<metric> over all` rule - this calculates the specific aggregation
metric and applies the threshold condition to the aggregated metric (for
example, `avg event.duration`). `{{context.hits}}` is all the documents
that match the query if the threshold condition is met.
* `count over top N terms` - this will apply a term aggregation to the
query and matches the threshold condition to each term bucket (for
example, `count over top 10 event.action` will apply the threshold
condition to the count of documents within each `event.action` bucket).
`{{context.hits}}` is the result of the top hits aggregation within each
term bucket if the threshold condition is met for that bucket.
* `<metric> over top N terms` - this will apply a term aggregation and a
metric sub-aggregation to the query and matches the threshold condition
to the metric value within each term bucket (for example, `avg
event.duration over top 10 event.action` will apply the threshold
condition to the average value of `event.duration` within each
`event.action` bucket). `{{context.hits}}` is the result of the top hits
aggregation within each term bucket if the threshold condition is met
for that bucket.
* Verify the migration by creating a DSL and KQL query in an older
version of Kibana and then upgrading to this PR. The rules should still
continue running successfully.


### Checklist

- [x]
[Documentation](https://www.elastic.co/guide/en/kibana/master/development-documentation.html)
was added for features that require explanation or tutorials
- [x] [Unit or functional
tests](https://www.elastic.co/guide/en/kibana/master/development-tests.html)
were updated or added to match the most common scenarios

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2022-12-15 11:03:58 -05:00
Lisa Cawley
dfbe40a33b
[DOCS] Update screenshots for Connectors app (#144870) 2022-11-17 09:10:54 -08:00
Lisa Cawley
2b143dadc4
[DOCS] Refresh screenshots for alerting banners (#145307) 2022-11-16 08:14:51 -08:00
Lisa Cawley
80b479a1b4
[DOCS] Add the Logs tab to Rules and Connectors (#144866) 2022-11-15 07:35:42 -08:00
Lisa Cawley
2115309d0a
Edit UI text for "exclude previous hits" check box in Elasticsearch query rule (#140146) 2022-09-07 08:34:35 -07:00
Ersin Erdal
7d3f762186
Add "exclude previous hits" check box to ESQuery rule form (#138781)
* Add "Exclude the hits from previous rule run" check box to ESQuery rule form
2022-09-05 13:09:09 +02:00
Lisa Cawley
6fc614a20c
[DOCS] Refresh screenshots for creating and managing rules (#138763) 2022-09-01 08:57:05 +09:30
Lisa Cawley
659d664f01
[DOCS] Update snooze and disable rules screenshots (#138693) 2022-08-26 13:45:41 -07:00
Zacqary Adam Xeper
1303044ae7
[RAM] Add docs for Snooze UX (#130297)
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-04-20 16:07:16 -07:00
Zacqary Adam Xeper
2569ca6fa7
[Docs] Update rules list screenshots in docs (#130487) 2022-04-19 12:59:31 -05:00
Ying Mao
873849d527
[Response Ops][Docs] Adding user facing docs for rule cancellation (#128677)
* Adding words

* PR feedback

* Update docs/user/alerting/troubleshooting/alerting-common-issues.asciidoc

Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>

Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2022-04-05 07:49:45 -04:00
Yuliia Naumenko
73e8871be0
[Alerting][Docs] Support enablement documentation. (#101457)
* [Alerting][Docs] Support enablement documentation.

* additional docs

* fixed links

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed common issues

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

* fixed TM health api page

* fixed TM health api page 2

* Apply suggestions from code review

Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
Co-authored-by: ymao1 <ying.mao@elastic.co>

* fixed due to the comments

* fixed due to the comments

* fixed experimental flag

* fixed due to the comments

* Apply suggestions from code review

Co-authored-by: ymao1 <ying.mao@elastic.co>

* Update docs/user/alerting/alerting-troubleshooting.asciidoc

Co-authored-by: ymao1 <ying.mao@elastic.co>

* fixed due to the comments

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: Mike Côté <mikecote@users.noreply.github.com>
2021-06-28 11:57:17 -07:00
ymao1
b242765654
[Alerting][Docs] Combine rule creation and management pages (#101498)
* Combining rule management stuff into single page

* Cleaning up image widths and header sizes

* Adding in placeholder pages

* Adding in placeholder pages

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR and test fixes

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* PR fixes

* PR fixes

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-10 17:46:53 -04:00
Yuliia Naumenko
8a344fa385
[Alerting] Enabling import of rules and connectors (#99857)
* [Alerting] Enabling import of rules and connectors

* changed export to set pending executionStatus for rule

* fixed tests

* added docs

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed docs

* fixed docs

* Update x-pack/plugins/alerting/server/saved_objects/get_import_warnings.ts

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed test

* fixed test

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-05-14 07:43:09 -07:00
Mike Côté
bb7057c343
Rename alert status OK to Recovered and fix some UX issues around disabling a rule while being in an error state (#98135)
* Fix UX when alert is disabled and in an error state

* Reset executionStatus to pending after enabling an alert

* Renames alert instance status OK to Recovered

* Fix end to end test

* Update doc screenshot

* Fix confusing test name

* Remove flakiness in integration test

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-05-13 14:16:36 -04:00
Yuliia Naumenko
9cf66a78e9
[Docs][Alerting] Changed overall alerting documentation structure (#95004)
* [Docs][Alerting] Changed overall alerting documentation structure

* fixed image link

* moved alerting and connectors under the graph in the menu list

* moved management docs to alerting and connectors

* fixed image link

* fixed connector menu position

* fixed mappings

* fixed mappings

* fixed links

* fixed levels

* move manage connectors before action types

* adjust connectors management

* adjust connectors management

* split domain specific and stack rules

* fixed rule types links

* added connectors ui images

* fixed image links

* fixed image links

* fixed image links

* test

* fixed image links

* fixed broken links

* fixed broken links

* fixed email links

* fixed email links

* fixed email links

* fixed links

* added images to connectors docs

* Update docs/user/alerting/rule-management.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Update docs/user/alerting/stack-rules.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

* fixed due to comments

* fixed create connector

* moved connectors to stack management section

* removed bazel files

* fixed managing-alerts-and-actions links

* Revert "fixed managing-alerts-and-actions links"

This reverts commit 0ed228b090.

* fixed code owners

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-19 15:54:54 -07:00
ymao1
71ed148cfe
[Alerting] Preconfigured alert history index connector (#94909)
* Adding preconfigured alert history index

* Adding functions to build alert history document

* Adding functions to build alert history document

* Moving index template creation to plugin start

* Adding unit tests

* Adding unit tests

* Adding unit tests

* Simplifying

* Revert "Merge branch 'master' of https://github.com/elastic/kibana into alerting/default-es-index-schema"

This reverts commit 957c333aa4, reversing
changes made to 4b1b78761e.

* Reverting some changes

* Reverting some changes

* Adding index override

* Updating UI with index override

* Only allow indexOverride for preconfigured alert history connector

* Handling preconfigured connector id clashes

* Cleanup

* UI unit tests

* Fixing default schema shown in UI

* Fixing functional tests

* Adding functional test

* Fixing functional tests

* Adding docs and link to docs

* Adding config to docker allowlist

* Fixing wrong typescript operator

* Changing default for config to false

* Cleanup

* Adding note about index privileges to docs

* Fixing i18n

* PR fixes

* PR fixes

* PR fixes

* PR fixes - wording

* PR fixes

* Fixing unit and functional tests

* Fixing types check

* ES -> Elasticsearch

* Moving files

* Adding kibana- to beginning of prefix

* Namespacing alert data within schema with kibana

* Fix i18n

* Updating docs

* Fixing unit tests

* Fixing doc links

* Fixing types check

* PR fixes

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-04-08 18:18:44 -04:00
ymao1
a7c9d3f1e0
[Alerting] Update UI to reflect new terminology (#93597)
* Renaming alerts to rules

* Updating formatted messages

* Updating i18n labels

* Completed renaming in UI

* Updating client routes including redirect

* wip docs update

* Reverting title changes for now

* Fixing types check

* Fixing unit tests

* Fixing functional test

* Fixing functional test

* docs wip

* wip docs update

* Finished first run through docs

* docs docs docs

* Fixing bad merge

* Fixing functional test

* Docs cleanup

* Cleaning up i18n labels

* Fixing functional test

* Updating screenshots

* Updating screenshots

* Updating screenshots

* Updating terminology in alerting examples

* Updating terminology in alerting examples

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-03-15 10:03:39 -04:00
Gidi Meir Morris
46247c6c55
[Alerting] Renames the "ES query" alert type to "Elasticsearch query" (#93584)
Tweaks UX for 7.12
2021-03-05 11:41:37 +00:00
ymao1
fda67adb9f
[Alerting][Docs] Adding template for documenting alert and action types (#92830)
* Alert type template

* Action type template

* Cleanup

* Cleanup

* Removing callout list

* Cleanup

* Apply suggestions from code review

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* Adding title to actions page

* PR fixes

* PR fixes

* PR fixes

* PR fixes

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-03-02 18:08:58 -05:00
ymao1
319ad55cd7
Different screenshot (#92970) 2021-03-02 15:24:06 -05:00
ymao1
e78d5f6d04
[Alerting][Docs] Documentation for action variables. (#92417)
* Adding action variable docs for index threshold and ES query alerts

* Adding section for common action variables

* Adding link to server publicBaseUrl

* PR fixes
2021-02-24 12:55:22 -05:00
Gidi Meir Morris
4c82ffc25f
[Docs][Alerting] updates images in Alerts Management and adds docs for the Run When field (#92225)
Updates images in Alerts Management Docs and usage of the Run When field
2021-02-23 12:54:55 +00:00
ymao1
192f19e30c
[Alerting][Docs] Updating docs for notify only on action group change (#92084)
* Updating docs for notify only on state change

* PR fixes

* Update docs/user/alerting/defining-alerts.asciidoc

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-02-22 11:39:48 -05:00