Type to search.

Applications UI annotation user

Stack

The Elastic Stack includes Elastic's core products such as Elasticsearch, Kibana, Logstash, and Beats.

Availability

  • Generally available

    This functionality is generally available and ready for production usage.

Unless stated otherwise on the page, this functionality is available when your Elastic Stack is deployed on Elastic Cloud Hosted, Elastic Cloud Enterprise, Elastic Cloud on Kubernetes, and self-managed environments.

This documentation corresponds to the latest patch available for each minor version. If you're not using the latest patch, check the release notes for changes.

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.