Commit graph

187 commits

Author SHA1 Message Date
Lisa Cawley
90d1bc6388
[DOCS] Stack Management Alerts app (#184384) 2024-06-05 16:12:54 -07:00
Lisa Cawley
ce47a73e84
[DOCS] Add Elasticsearch query rule action variables and data types (#183691) 2024-06-04 18:54:14 -07:00
Lisa Cawley
b1916090d0
[DOCS] Cases connector (#183349) 2024-05-23 09:43:45 -07:00
Lisa Cawley
06e147e021
[DOCS] Fix docs and screenshots for rule creation changes (#181925) 2024-05-01 09:18:17 -07:00
Lisa Cawley
bd2d9e6016
[DOCS] Add description for untracked alert status (#176974) 2024-04-04 15:06:18 -07:00
Lisa Cawley
0bc830ea29
[DOCS] Add alert.consecutiveMatches and rule.url action variables (#179018) 2024-03-20 21:45:05 +00:00
Lisa Cawley
ea99e780e7
[DOCS] Clarify that all rules support alert summaries (#177755) 2024-03-12 21:20:14 +00:00
Lisa Cawley
0c6701d4a7
[DOCS] Add alert creation delay in Stack rules (#178461) 2024-03-12 14:57:34 +00:00
DeDe Morton
5e09b74e9c
Add statement about defining security rules (#178463)
## Summary

Pushing a commit that _should_ have been part of
https://github.com/elastic/kibana/pull/177525

### Checklist

Delete any items that are not applicable to this PR.

- [x] Any text added follows [EUI's writing
guidelines](https://elastic.github.io/eui/#/guidelines/writing), uses
sentence case text and includes [i18n
support](https://github.com/elastic/kibana/blob/main/packages/kbn-i18n/README.md)
2024-03-11 15:59:38 -07:00
DeDe Morton
881980aea0
[DOCS] Replace table of links with single link to Obs alerting docs (#177525)
## Summary

Replaces the categorized table of links with a single link to the
observability alerting docs because this table is likely to get stale
over time (in fact, it already is stale).

The change looks like this when rendered in HTML:


![image](a3f67a18-f227-435d-9b56-ddb221cdce7c)


Notes/open issues:
- [x] The [main alerting
page](https://www.elastic.co/guide/en/kibana/master/alerting-getting-started.html)
for Kibana now has links to related alerting documentation, but is it
clear that those links point to docs that describe how to manage alerts
from those apps? The link text seems maybe not descriptive enough and
might be causing confusion. _NO CHANGE REQUIRED: I'm going to leave this
as-is because I think the feedback we received initially about the lack
of links was before the links were added._
- [x] In the intro, I feel a thought might be missing from this
statement: "For information on creating security rules, refer to Create
a detection rule." Should this instead say something like: "Security
rules must be defined in the Security app. For more information, refer
to the security docs about creating a detection rule." _RESOLVED_
- [x] I think the descriptions about each app's alerting capabilities
should be more consistent, but I don't want to rewrite other folk's
sections. So I have aligned my description with the security section,
for better or worse. It's hard to make this info consistent when each
solution/app is doing its own thing with alerting. _DEFERRED: We will
fix inconsistencies later._
- [x] Is it correct to say "create alerts" rather than something like
"trigger alerts" or "generate alerts"? _RESOLVED: Will keep as "create"
for now since the UI is not using "trigger."_

### Checklist

n/a

cc @lcawl Can you help me sort through my list of open issues?

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2024-03-11 11:34:31 -07:00
Lisa Cawley
ec5c7a402a
[DOCS] Improve tracking containment rule (#176979) 2024-02-21 18:15:14 -07:00
Lisa Cawley
4ff1f5941f
[DOCS] Warn against using ES|QL query rules on production environments (#174130) 2024-01-04 02:46:43 +10:30
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
6ac15df661
[DOCS] Elasticsearch query rule group by multiple terms (#170675) 2023-11-06 13:56:57 -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
622b14de67
[DOCS] Clarify Opsgenie and PagerDuty connector actions (#163548) 2023-09-12 09:59:38 -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
Nathan Reese
3393d87959
Add support for geo_shape fields as the entity geospatial field when creating tracking containment alerts (#164100)
Closes https://github.com/elastic/kibana/issues/163996

### To test
1) Checkout [fake tracks geo_shape
branch](https://github.com/nreese/faketracks/tree/geo_shape)
2) run npm install
3) run `node ./generate_tracks.js`
4) in kibana, create `tracks*` data view
5) create map, use "create index" and draw boundaries that intersect
tracks. See screen shot
<img width="500" alt="Screen Shot 2023-08-17 at 2 49 52 PM"
src="5f1444d7-2e12-4dd2-99c1-c730c2157e04">
6) create geo containment alert where entity index is `tracks*` and
boundaries index is `boundaries`.
7) Verify alerts get generated with entity geo_shape locations

---------

Co-authored-by: kibanamachine <42973632+kibanamachine@users.noreply.github.com>
2023-08-23 13:12:46 -06:00
Lisa Cawley
154ca404d0
[DOCS] Automate Elasticsearch query rule screenshots (#164127) 2023-08-23 11:41:44 -07:00
Abdon Pijpelink
4b1d833aee
[DOCS] Change deep link to ES book for CCS privileges (#164165)
## Summary

Relates to https://github.com/elastic/elasticsearch/pull/98330

8.10 introduces a new method to configure remote clusters (API key
based), which will live next to the existing method (certificate based).
As a result, the ES remote cluster docs will be restructured. The deep
link from "[Alerting set
up](https://www.elastic.co/guide/en/kibana/current/alerting-setup.html#alerting-ccs-setup)"
to the setting up CCS privileges section in the ES docs will break (and
would potentially bring folks to the wrong page anyway).

This PR changes the link into a link to the higher-level remote cluster
docs, from where folks can click through to the section that is relevant
to them.
2023-08-22 09:33:53 +02: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
3a0c90d934
[DOCS] Clarify API key authorization for alerting (#161717) 2023-07-17 09:41:23 -07:00
Lisa Cawley
48ec52b202
[DOCS] Link to rule and connector Elasticstack provider resources (#161275) 2023-07-17 08:34:10 -07:00
Mike Birnstiehl
575def18cf
[DOCS] update observability alerting links (#161980) 2023-07-17 09:47:07 -05:00
Stef Nestor
b1d619617a
[DOCv2] Temporarily disable Kibana Rules (#126869)
👋🏼 @gchaps asked me to file a new PR since my last
https://github.com/elastic/kibana/pull/122573 got too far behind.

## Summary

🙏🏼 per #116017, adds insight on how to temporarily disable Kibana Rules
for clusters which need breathing room.

---------

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: Lisa Cawley <lcawley@elastic.co>
2023-07-13 08:22:55 -05:00
Lisa Cawley
7f3c9e8c81
[DOCS] Add rule.params to rule action variables (#161714) 2023-07-12 09:56:57 -07:00
Lisa Cawley
4ce8b3f4eb
[DOCS] Edits FormatNumber examples for rule action variables (#161678) 2023-07-11 10:39:30 -07:00
Patrick Mueller
d9ca8aa48f
[ResponseOps] adds FormatNumber mustache lambda (#159644)
resolves https://github.com/elastic/kibana/issues/155869

Adds mustache lambda `{{#FormatNumber}}`, which uses
[Intl.NumberFormat][] to format the number.

[Intl.NumberFormat]:
https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat
2023-06-20 09:34:55 -04:00
Lisa Cawley
4cf817a1ab
[DOCS] Allow users authenticated with API keys to manage alerting rules (#158428) 2023-05-25 10:32:11 -07:00
Lisa Cawley
4981f37014
[DOCS] Clarify support for data views in stack rules (#158431) 2023-05-25 07:53:57 -07:00
Lisa Cawley
c5a1d6b5f4
[DOCS] Conditional actions in Kibana alerting summary (#158045) 2023-05-23 10:50:17 -07:00
Lisa Cawley
1b71d2ca3c
[DOCS] Maintenance window column in alerts tables (#158125) 2023-05-23 10:49:18 -07:00
Lisa Cawley
93b15b14e5
[DOCS] Maintenance windows (#157806) 2023-05-17 11:01:40 -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
Patrick Mueller
cd727fa190
[ResponseOps] move alert UUID generation from rule registry to the alerting framework (#143489)
resolves https://github.com/elastic/kibana/issues/142874

The alerting framework now generates an alert UUID for every alert it
creates. The UUID will be reused for alerts which continue to be active
on subsequent runs, until the alert recovers. When the same alert (alert
instance id) becomes active again, a new UUID will be generated. These
UUIDs then identify a "span" of events for a single alert.

The rule registry plugin was already adding these UUIDs to it's own
alerts-as-data indices, and that code has now been changed to make use
of the new UUID the alerting framework generates.

- adds property in the rule task state
`alertInstances[alertInstanceId].meta.uuid`; this is where the alert
UUID is persisted across runs
- adds a new `Alert` method getUuid(): string` that can be used by rule
executors to obtain the UUID of the alert they just retrieved from the
factory; the rule registry uses this to get the UUID generated by the
alerting framework
- for the event log, adds the property `kibana.alert.uuid` to
`*-instance` event log events; this is the same field the rule registry
writes into the alerts-as-data indices
- various changes to tests to accommodate new UUID data / methods
- migrates the UUID previous stored with lifecycle alerts in the alert
state, via the rule registry *INTO* the new `meta.uuid` field in the
existing alert state.
2023-04-03 09:19:48 -04: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
ff312c9f04
[DOCS] Clarify alerting security (#150653) 2023-02-14 09:14:05 -08:00