Grant users access to Functionbeat indices

edit

To enable users to access the indices Functionbeat creates, grant them read and view_index_metadata privileges on the Functionbeat indices. If they’re using Kibana, they also need the kibana_user role.

  1. Create a reader role that has the read and view_index_metadata privileges on the Functionbeat indices.

    You can create roles from the Management > Roles UI in Kibana or through the role API. For example, the following request creates a role named functionbeat_reader:

    POST _xpack/security/role/functionbeat_reader
    {
      "indices": [
        {
          "names": [ "functionbeat-*" ], 
          "privileges": ["read","view_index_metadata"]
        }
      ]
    }

    If you use a custom Functionbeat index pattern, specify that pattern instead of the default functionbeat-* pattern.

  2. Assign your users the reader role so they can access the Functionbeat indices. For Kibana users who need to visualize the data, also assign the kibana_user role:

    1. If you’re using the native realm, you can assign roles with the Management > Users UI in Kibana or through the user API. For example, the following request grants functionbeat_user the functionbeat_reader and kibana_user roles:

      POST /_xpack/security/user/functionbeat_user
      {
        "password" : "YOUR_PASSWORD",
        "roles" : [ "functionbeat_reader","kibana_user"],
        "full_name" : "Functionbeat User"
      }
    2. If you’re using the LDAP, Active Directory, or PKI realms, you assign the roles in the role_mapping.yml configuration file. For example, the following snippet grants Functionbeat User the functionbeat_reader and kibana_user roles:

      functionbeat_reader:
        - "cn=Functionbeat User,dc=example,dc=com"
      kibana_user:
        - "cn=Functionbeat User,dc=example,dc=com"

      For more information, see Using Role Mapping Files.