IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Grant privileges and roles needed for monitoring Grant privileges and roles needed to read Metricbeat data from Kibana »
Elastic Docs ›Metricbeat Reference [7.8] ›Secure Metricbeat ›Grant users access to secured resources

Grant privileges and roles needed for publishing

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Grant privileges and roles needed for publishing

edit

Users who publish events to Elasticsearch need to create and write to Metricbeat indices. To minimize the privileges required by the writer role, use the setup role to pre-load dependencies. This section assumes that you’ve pre-loaded dependencies.

When using ILM, turn off the ILM setup check in the Metricbeat config file before running Metricbeat to publish events:

setup.ilm.check_exists: false

To grant the required privileges:

  1. Create a writer role, called something like metricbeat_writer, that has the following privileges:

    The monitor cluster privilege and the create_doc privilege on metricbeat-* indices are required in every configuration.

    Type Privilege Purpose

    Cluster

    monitor

    Retrieve cluster details (e.g. version)

    Cluster

    read_ilm

    Read the ILM policy when connecting to clusters that support ILM. Not needed when setup.ilm.check_exists is false.

    Index

    create_doc on metricbeat-* indices

    Write events into Elasticsearch

    Index

    view_index_metadata on metricbeat-* indices

    Check for alias when connecting to clusters that support ILM. Not needed when setup.ilm.check_exists is false.

    Index

    create_index on metricbeat-* indices

    Create daily indices when connecting to clusters that do not support ILM. Not needed when using ILM.

    Omit any privileges that aren’t relevant in your environment.

  2. Assign the writer role to users who will index events into Elasticsearch.
« Grant privileges and roles needed for monitoring Grant privileges and roles needed to read Metricbeat data from Kibana »