This documentation contains work-in-progress information for future Elastic Stack and Cloud releases. Use the version selector to view supported release docs. It also contains some Elastic Cloud serverless information. Check out our serverless docs for more details.
APM UI annotation user
editAPM UI annotation user
editBy default, the viewer
and editor
built-in roles provide read access to Observability annotations.
You only need to create an annotation user to write to the annotations index
(xpack.observability.annotations.index
).
View deployment annotations in the APM UI.
-
Create a new role, named something like
annotation_user
, and assign the following privileges:Type Privilege Purpose Index
read
on{ANNOTATION_INDEX}
1Read-only access to the observability annotation index
Index
view_index_metadata
on{ANNOTATION_INDEX}
1Read-only access to observability annotation index metadata
1
{ANNOTATION_INDEX}
should be the index name you’ve defined inxpack.observability.annotations.index
. -
Assign the
annotation_user
created previously, and the roles and privileges necessary to create a full or partial APM reader to any users that need to view annotations in the APM UI
See Create an API user.