Alerting set up
editAlerting set up
editAlerting is automatically enabled in Kibana, but might require some additional configuration.
Prerequisites
editIf you are using an on-premises Elastic Stack deployment:
-
In the kibana.yml configuration file, add the
xpack.encryptedSavedObjects.encryptionKey
setting. -
For emails to have a footer with a link back to Kibana, set the
server.publicBaseUrl
configuration setting.
If you are using an on-premises Elastic Stack deployment with security:
- If you are unable to access Kibana Alerting, ensure that you have not explicitly disabled API keys.
The alerting framework uses queries that require the search.allow_expensive_queries
setting to be true
. See the scripts documentation.
Production considerations and scaling guidance
editWhen relying on alerting and actions as mission critical services, make sure you follow the Alerting production considerations.
See Scaling guidance for more information on the scalability of Alerting.
Security
editTo access alerting in a space, a user must have access to one of the following features:
See feature privileges for more information on configuring roles that provide access to these features.
Also note that a user will need read
privileges for the Actions and Connectors feature to attach actions to a rule or to edit a rule that has an action attached to it.
Restrict actions
editFor security reasons you may wish to limit the extent to which Kibana can connect to external services. Action settings allows you to disable certain Connectors and allowlist the hostnames that Kibana can connect with.
Space isolation
editRules and connectors are isolated to the Kibana space in which they were created. A rule or connector created in one space will not be visible in another.
Authorization
editRules are authorized using an API key associated with the last user to edit the rule. This API key captures a snapshot of the user’s privileges at the time of edit and is subsequently used to run all background tasks associated with the rule, including condition checks like Elasticsearch queries and triggered actions. The following rule actions will re-generate the API key:
- Creating a rule
- Enabling a disabled rule
- Updating a rule
If a rule requires certain privileges, such as index privileges, to run, and a user without those privileges updates, disables, or re-enables the rule, the rule will no longer function. Conversely, if a user with greater or administrator privileges modifies the rule, it will begin running with increased privileges.
Cross-cluster search
editIf you want to use alerting rules with cross-cluster search, you must configure privileges for CCS and Kibana.