Clarify the permissions required for the jmx exporter user

[rgl]

Description

in order to use the prometheus jmx exporter we need a user, but its not clear to me which permissions should this user have. in theory, this user would only require some kind of read-only permissions, correct?

can you please clarify which permissions should be granted to a hypothetical jmx_exporter role?

the instructions at https://apim.docs.wso2.com/en/latest/observe/api-manager/metrics/jmx-based-monitoring/#starting-the-wso2-product-with-jmx has this informational note:

Make sure that the user ID you are using for JMX monitoring is assigned a role that has the Server Admin permission. See Configuring Roles for further information about configuring roles assigned to users. Any user assigned to the admin role can log in to JMX.

But I'm sure sure what "Server Admin permission" means. Is it the "Server Admin" from the Carbon new role creation page:

Instead of "Server Admin", shouldn't we use "Read Only" (under All Permissions, Super Admin Permissions, Server Admin, Java Management Extensions) instead?

If so, can the documentation be updated with this information? And maybe also include an jmx_exporter role out-of-the-box?

Affected Component

APIM

Version

4.3.0

Environment Details (with versions)

N/A

Related Issues

No response

Suggested Labels

No response