IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.

« APM reader user APM UI central config user »

› › › ›

APM UI annotation user

edit

APM UI annotation user

edit

By 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).

Annotation user

edit

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}`¹	Read-only access to the observability annotation index
Index	`view_index_metadata` on `{ANNOTATION_INDEX}`¹	Read-only access to observability annotation index metadata

¹ {ANNOTATION_INDEX} should be the index name you’ve defined in xpack.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

Annotation API

edit

See Create an API user.

« APM reader user APM UI central config user »