github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-23 09:19:04 -04:00
Code Issues Projects Releases Packages Wiki Activity

docs: add annotation user docs (#70265)

Browse source
This commit is contained in:
Brandon Morelli 2020-07-06 10:36:44 -07:00 • committed by GitHub
parent 93bae2284c
commit 5b5aa70df7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 50 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/apm/api.asciidoc
View file

@ -355,6 +355,7 @@ allowing you to easily see how these events are impacting the performance of you
By default, annotations are stored in a newly created `observability-annotations` index.
The name of this index can be changed in your `config.yml` by editing `xpack.observability.annotations.index`.
If you change the default index name, you'll also need to <<apm-app-annotation-user-create,update your user privileges>> accordingly.
The following APIs are available:

50
docs/apm/apm-app-users.asciidoc
View file

@ -4,7 +4,7 @@
:beat_default_index_prefix: apm
:beat_kib_app: APM app
:annotation_index: `observability-annotations`
:annotation_index: observability-annotations
++++
<titleabbrev>Users and privileges</titleabbrev>
@ -102,6 +102,54 @@ Here are two examples:
*********************************** ***********************************
////
[role="xpack"]
[[apm-app-annotation-user-create]]
=== APM app annotation user
++++
<titleabbrev>Create an annotation user</titleabbrev>
++++
NOTE: By default, the `apm_user` built-in role provides access to Observability annotations.
You only need to create an annotation user if the default annotation index
defined in <<apm-settings-kb,`xpack.observability.annotations.index`>> has been customized.
[[apm-app-annotation-user]]
==== Annotation user
View deployment annotations in the APM app.
. Create a new role, named something like `annotation_user`,
and assign the following privileges:
+
[options="header"]
|====
|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
<<apm-settings-kb,`xpack.observability.annotations.index`>>.
. Assign the `annotation_user` created previously, and the built-in roles necessary to create
a <<apm-app-reader-full,full>> or <<apm-app-reader-partial,partial>> APM reader to any users that need to view annotations in the APM app
[[apm-app-annotation-api]]
==== Annotation API
See <<apm-app-api-user>>.
////
*********************************** ***********************************
////
[role="xpack"]
[[apm-app-central-config-user]]
=== APM app central config user