This is a cache of https://www.elastic.co/docs/solutions/observability/apm/ui-user-annotation. It is a snapshot of the page at 2025-10-31T00:53:22.052+0000.
Applications UI annotation user | Elastic Docs
Loading

Applications UI annotation user

Stack

Note

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

View deployment annotations in the Applications UI.

  1. Create a new role, named something like annotation_user, and assign the following privileges:

    Type Privilege Purpose
    Index read on {{ANNOTATION_INDEX}}1 Read-only access to the observability annotation index
    Index view_index_metadata on {{ANNOTATION_INDEX}}1 Read-only access to observability annotation index metadata

    1 {{ANNOTATION_INDEX}} should be the index name you’ve defined in xpack.observability.annotations.index.

  2. 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 Applications UI

See Create an API user.