You're viewing version 2.16 of the OpenSearch documentation. This version is no longer maintained. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.

Adding comments

This is an experimental feature and is not recommended for use in a production environment. For updates on the progress of the feature or if you want to leave feedback, see the associated GitHub issue.

When an alert is generated, add comments to share information about its root cause and facilitate resolution. Comments are enabled by setting plugins.alerting.comments_enabled to true using the cluster/settings API.

Comments can be accessed through the alerts table view by selecting the comment icon within an alert’s row. From there, comments can be added, edited, or deleted. An Alerting Comments API is also available for programmatic comment management. For more information, see Alerting API.

Viewing comment authors

If the Security plugin is installed, then the comment’s author is displayed. Otherwise, Unknown is displayed.

Assigning permissions

Comment permissions are determined by the backend roles associated with the alert. These backend roles are inherited from the monitor that generated the alert. For more information about how to limit access based on backend roles, see Limit access by backend role.