APM reader user
APM reader users typically need to view the Applications UI and dashboards and visualizations that use APM data. These users might also need to create and edit dashboards, visualizations, and machine learning jobs.
APM reader ¶
To create an APM reader user:
- Create a new role, named something like
read-apm
, and assign the following privileges: <div class="tabs" data-tab-group="apm-app-reader">
<div role="tablist" aria-label="Applications UI reader">
<button role="tab"
aria-selected="true"
aria-controls="data-streams-tab"
id="data-streams">
Data streams
</button>
<button role="tab"
aria-selected="false"
aria-controls="classic-indices-tab"
id="classic-indices"
tabindex="-1">
Classic APM indices
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="data-streams-tab"
aria-labelledby="data-streams">
| Type | Privilege | Purpose |
| --- | --- | --- |
| Index |read
onlogs-apm*
| Read-only access tologs-apm*
data |
| Index |view_index_metadata
onlogs-apm*
| Read-only access tologs-apm*
index metadata |
| Index |read
onmetrics-apm*
| Read-only access tometrics-apm*
data |
| Index |view_index_metadata
onmetrics-apm*
| Read-only access tometrics-apm*
index metadata |
| Index |read
ontraces-apm*
| Read-only access totraces-apm*
data |
| Index |view_index_metadata
ontraces-apm*
| Read-only access totraces-apm*
index metadata | </div>
<div tabindex="0"
role="tabpanel"
id="classic-indices-tab"
aria-labelledby="classic-indices"
hidden="">
| Type | Privilege | Purpose |
| --- | --- | --- |
| Index |read
onapm-*
| Read-only access toapm-*
data |
| Index |view_index_metadata
onapm-*
| Read-only access toapm-*
index metadata | </div>
</div> - Assign the
read-apm
role created in the previous step, and the following built-in roles to any APM reader users:Role Purpose kibana_admin
Grants access to all features in Kibana. machine_learning_admin
Grants the privileges required to create, update, and view machine learning jobs
Partial APM reader ¶
In some instances, you may wish to restrict certain Kibana apps that a user has access to.
- Create a new role, named something like
read-apm-partial
, and assign the following privileges: <div class="tabs" data-tab-group="apm-app-reader">
<div role="tablist" aria-label="Applications UI reader">
<button role="tab"
aria-selected="true"
aria-controls="data-streams-tab"
id="data-streams">
Data streams
</button>
<button role="tab"
aria-selected="false"
aria-controls="classic-indices-tab"
id="classic-indices"
tabindex="-1">
Classic APM indices
</button>
</div>
<div tabindex="0"
role="tabpanel"
id="data-streams-tab"
aria-labelledby="data-streams">
| Type | Privilege | Purpose |
| --- | --- | --- |
| Index |read
onlogs-apm*
| Read-only access tologs-apm*
data |
| Index |view_index_metadata
onlogs-apm*
| Read-only access tologs-apm*
index metadata |
| Index |read
onmetrics-apm*
| Read-only access tometrics-apm*
data |
| Index |view_index_metadata
onmetrics-apm*
| Read-only access tometrics-apm*
index metadata |
| Index |read
ontraces-apm*
| Read-only access totraces-apm*
data |
| Index |view_index_metadata
ontraces-apm*
| Read-only access totraces-apm*
index metadata | </div>
<div tabindex="0"
role="tabpanel"
id="classic-indices-tab"
aria-labelledby="classic-indices"
hidden="">
| Type | Privilege | Purpose |
| --- | --- | --- |
| Index |read
onapm-*
| Read-only access toapm-*
data |
| Index |view_index_metadata
onapm-*
| Read-only access toapm-*
index metadata | </div>
</div> - Assign feature privileges to any Kibana feature that the user needs access to. Here are two examples:
Type Privilege Purpose Kibana Read
orAll
on the APM and User Experience featureAllow the use of the the Applications and User Experience UIs Kibana Read
orAll
on Dashboards and DiscoverAllow the user to view, edit, and create dashboards, as well as browse data. - Finally, assign the following role if a user needs to enable and edit machine learning features:
Role Purpose machine_learning_admin
Grants the privileges required to create, update, and view machine learning jobs