Commit graph

99 commits

Author SHA1 Message Date
garanews
58f6d9002a
Fix typos in docs & dev_docs (#113746) 2021-10-07 14:30:32 -04:00
Yuliia Naumenko
73f232f5b3
[Alerting][Docs] Elasticsearch setting search.allow_expensive_queries should be set as true. (#113062)
* [Alerting][Docs] Elasticsearch setting search.allow_expensive_queries should be set to true.

* fixed text

* fixed text

* fixed due to comments

* Update alerting-setup.asciidoc
2021-10-04 15:20:11 -07:00
ymao1
9132b43128
[Alerting][Docs] Add de-duplication example to ES query docs + update email docs wording (#111026)
* Change to allowlist

* Adding example to es query rule

* Apply suggestions from code review

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

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-09-03 18:48:45 -04:00
ymao1
df8ed81195
Adding experimental to event log mentions in the docs (#110876) 2021-09-03 07:35:17 -04:00
ymao1
be2ca2201c
[Alerting][Docs] Updating alerting setup docs (#109285)
* Updating alerting authorization docs

* Apply suggestions from code review

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

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-08-24 08:23:33 -04:00
ymao1
df421f869f
[Alerting] Fix health check to allow access to alerting when ES security is disabled (#107032)
* Using license plugin to check if es security is enabled

* Adding unit tests and updating legacy health route

* Updating UI copy and docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-08-02 10:37:30 -04:00
Mike Côté
dd142c460f
Fix doc on ok rule status (#106545) 2021-07-22 13:39:24 -04:00
James Rodewig
4ad517f996
[DOCS] Update Watcher reference (#106565)
Kibana Alerting is now the preferred method for alerting in Elastic. To avoid confusion, we should use "Watcher" and avoid terms like "Elasticsearch alerting."

This updates a reference on the Alerting page. Relates to https://github.com/elastic/elasticsearch/pull/75220
2021-07-22 13:19:09 -04:00
Yuliia Naumenko
bd0f0584e0
[Alerting][Docs] Fixed formatting issues for alerting documentation. Added docs about rules statuses. (#103725)
* [Alerting][Docs] Fixed formatting issues for alerting documentation. Added docs about rules statuses.

* Apply suggestions from code review

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

* Apply suggestions from code review

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

* fixed due to the comments

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: ymao1 <ying.mao@elastic.co>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-06-30 10:34:59 -07:00
ymao1
c05588f077
[Alerting] Enable rule import/export and allow rule types to exclude themselves from export (#102999)
* Removing feature flag changes

* Adding isExportable flag to rule type definition

* Adding isExportable flag to rule type definition

* Adding isExportable flag to rule type definition

* Filtering rule on export by rule type isExportable flag

* Fixing types

* Adding docs

* Fix condition when exportCount is 0

* Unit test for fix condition when exportCount is 0

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-28 20:35:27 -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
Mike Côté
5ffe26cbf3
Add "Unable to decrypt attribute apiKey" to the alerting troubleshooting docs (#101315)
* Initial commit

* PR feedback

* PR feedback pt 2

* PR feedback pt 3
2021-06-22 12:30:40 -04:00
ymao1
f53fc8d3de
[Alerting][Docs] Removing placeholder sections in docs (#101953)
* Removing placeholder prerequisite section

* Removing placeholder defining-rules and rule-management

* Fixing links

* Setup to set up

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-06-21 14:27:18 -04:00
ymao1
61602fe2be
[Alerting][Docs] Reformatting rule types docs (#101420)
* Reformatting rule types docs

* Apply suggestions from code review

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

* Restructure geo rule page

* Apply suggestions from code review

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

* PR fixes

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-06-14 20:40:43 -04: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
ymao1
5a1f370580
[Alerting][Docs] Moving alerting setup to its own page (#101323)
* Restructuring main alerting page. Adding separate setup page

* Fixing links

* Moving suppressing duplicate notifications section

* Adding redirect

* Reverting redirect. Adding placeholder link

* Adding placeholder text

* Apply suggestions from code review

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

* Setup page PR fixes

* Alerting page PR fixes

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

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

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-06-10 15:14:07 -04:00
ymao1
c0f9970a55
[Alerting] Adding feature flag for enabling/disabling rule import and export (#100718)
* Adding feature flag for enabling rule import and export

* Removing item from docs

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-05-28 09:52:58 -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
ymao1
4ab86c77d4
[Alerting] Export rules and connectors (#98802)
* Adding importableAndExportable but hidden saved object types to saved object feature privilege

* Adding helper function for transforming rule for export. Added audit logging

* Adding helper function for transforming rule for export. Added audit logging

* Adding unit test for transforming rules for export

* Exporting connectors

* Removing auditing during export

* Adding import/export to docs

* PR fixes

* Using action type validation onExport

* Fixing logic for connectors with optional secrets

* Fixing logic for connectors with optional secrets

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-05-05 11:33:01 -04:00
ymao1
582c6c7ae3
[Alerting][Docs] Adding query to identify long running rules to docs (#98773)
* Adding query to identify long running rules to docs

* Wording suggestsion from PR review

* Adding event.provider to query. Allowing copy to console

* Adding note for system privileges

* Adding runtime field to query

* Removing extra dollar sign

* PR fixes
2021-05-03 19:18:13 -04:00
Patrick Mueller
b31f4a1a97
[actions] adds config allowing per-host networking options (#96630)
resolves: https://github.com/elastic/kibana/issues/80120

Adds a new Kibana configuration key xpack.actions.customHostSettings which
allows per-host configuration of connection settings for https and smtp for
alerting actions. Initially this is just for TLS settings, expandable to other
settings in the future.

The purpose of these is to allow customers to provide server certificates for
servers accessed by actions, whose certificate authority is not available
publicly. Alternatively, a per-server rejectUnauthorized: false configuration
may be used to bypass the verification step for specific servers, but require it
for other servers that do not have per-host customization.

Support was also added to allow per-host customization of ignoreTLS and
requireTLS flags for use with the email action.
2021-04-28 15:26:47 -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
4f6bd31c91
[Alerting] Fixing notifyWhen terminology (#96490)
* Updating terminology

* Updating wording

* Updating wording
2021-04-12 21:12:45 -04: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
István Zoltán Szabó
6205fbe62e
[DOCS] Adds beta tag to anomaly detection alert type. (#93765) 2021-03-08 09:56:26 +01: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
Gidi Meir Morris
79134b3b6d
[Alerting][Docs] Adds Alerting & Task Manager Scalability Guidance & Health Monitoring (#91171)
Documentation for scaling Kibana alerting, what configurations can change, what impacts they have, etc.
Scaling Alerting relies heavily on scaling Task Manager, so these docs also document Task manager Health Monitoring and scaling.
2021-03-04 14:11:53 +00:00
Patrick Mueller
60adc73afa
[alerting] adds doc on JSON-expanded action variables and task manager max_workers (#92720)
resolves https://github.com/elastic/kibana/issues/90006

For task manager, adds a note about the fact that the max_workers will be
limited to 100 starting in 8.0.  Currently we allow any value (because we
always have), but do print a "deprecation" warning that the limit cannot
be exceeded starting in 8.0

For alerting, adds note about the JSON expansion of action variables which are objects.
2021-03-03 16:48:30 -05: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
3dd3297371
[Actions][Docs] Moving subaction and subaction params back to README (#92878)
* Moving subaction and subaction params back to README

* Apply suggestions from code review

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

* 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 13:09:53 -05:00
Yuliia Naumenko
7a1944a5a0
[Alerting][Docs] Changed alerting documentation to point to a single source of explaining the configurations. (#92942)
* [Alerting][Docs] Changed alerting documentation to poin to a single source of explaining the configurations.

* fixed due to comments

* fixed due to comments

* Apply suggestions from code review

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

* fixed due to comments

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-03-01 19:34:27 -08:00
Lisa Cawley
3e026a3c3c
[DOCS] Fixes links for machine learning alerts (#92744)
Co-authored-by: Yuliia Naumenko <jo.naumenko@gmail.com>
2021-03-01 18:07:57 -08:00
Yuliia Naumenko
0627573dbd
[Alerts][Docs] Extended README.md and the user docs with the licensing information. (#92564)
* [Alerts][Docs] Extended README.md and the user docs with the licensing information.

* Apply suggestions from code review

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

* fixed due to comments

Co-authored-by: Lisa Cawley <lcawley@elastic.co>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-02-25 12:41:48 -08:00
Yuliia Naumenko
83b22dc568
[Actions][Doc] Added user doc for default value for PagerDuty deduplication key. (#92746)
* [Actions][Doc] Added user doc for default value for PagerDuty deduplication key.

* Apply suggestions from code review

Co-authored-by: Gidi Meir Morris <github@gidi.io>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>

Co-authored-by: Gidi Meir Morris <github@gidi.io>
Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-02-25 10:56:32 -08: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
ymao1
69bf127730
[Actions][Doc] Clean up Actions README (#91789)
* Removing REST API from README. Updating configuration docs

* Updating action config docs

* Cleaning up action type configs in README and user docs

* Cleaning up action type configs in README and user docs

* Fixing formatting

* Apply suggestions from code review

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

* PR fixes

* Update x-pack/plugins/actions/README.md

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

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-02-23 21:29:41 -05:00
Yuliia Naumenko
561a267876
[Alerts][Docs] Alert types doc update. Added refs to applications specific alerts groups. (#91787)
* [Alerts][Docs] Alert types doc update. Added refs to applications specific alerts groups.

* fixed ci

* fixed ci

* fixed ci

* fixed ci

* fixed alignment of pages

* fixed addtional links

* fixed titles

* Apply suggestions from code review

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

* Update docs/management/alerting/alert-management.asciidoc

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

* renamed titles

* moved maps to own folder

* renamed titles

* removed mistake file

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-02-23 15:12:22 -08:00
Mike Côté
b337d49bcb
Catch-up release documentation (#92411)
* Initial commit

* Undo custom id docs (done in separate PR)

* Update docs, a bit

* fix create api doc

* Update docs/user/alerting/action-types/email.asciidoc

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

* Update docs/user/alerting/alerting-getting-started.asciidoc

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

* Indent warning

Co-authored-by: gchaps <33642766+gchaps@users.noreply.github.com>
2021-02-23 11:26:12 -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
Nathan L Smith
6ad09a856a
Change "whitelist" to "allowlist" on alerting getting started (#92260) 2021-02-22 21:00:45 -06:00
Nathan L Smith
84e16ebcd0
Pluralize "alerts" (#92261) 2021-02-22 21:00:08 -06: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
ymao1
88ac3bf541
[Actions][Docs] Actions and Connectors API Docs (#90974)
* Stubbing out asciidocs

* wip

* Finishing connector API docs

* Cleanup

* Removing experimental label

* PR fixes

* PR fixes

* PR fixes
2021-02-17 13:43:25 -05:00
István Zoltán Szabó
26f088970e
[DOCS] Adds machine learning to the security section of alerting (#91501) 2021-02-17 12:11:48 +01:00
Gidi Meir Morris
3a05b681ae
[Docs][Alerting] fixed link to TM settings (#91368)
Fixed link to TM settings doc
2021-02-16 14:49:07 +00:00
Gidi Meir Morris
4834de661e
[Alerting][Docs] adds documentation on NTP based synchronization (#90747)
Adds docs on usage of NTP to sync nodes in a prod setting for alerting.
2021-02-11 10:36:07 +00:00
ymao1
5f8de693b9
[Alerting] Configurable number of hits for ES query alert (#90089)
* Adding size parameter to ES query alert

* Can't use const inside validation

* Updating docs

* Fixing functional test

* License

Co-authored-by: Kibana Machine <42973632+kibanamachine@users.noreply.github.com>
2021-02-09 14:07:53 -05:00