docs: Document privileges to read RUM source maps; Update examples #11741
Conversation
carsonip
added
backport-8.7
|
|
||
| The above privileges should be sufficient for RUM source mapping to work properly | ||
| as long as {beatname_uc} communicates with {es} successfully. | ||
| If it fails, it may fallback to read source maps via {kib} if configured, |
There was a problem hiding this comment.
[For reviewer] Keeping it slightly ambiguous to avoid describing the entire decision tree implementation detail of fallback logic. This paragraph exists to maintain the pointer to the relevant kibana docs.
Co-authored-by: Brandon Morelli <[email protected]>
|
The example here may need to be updated as well: https://www.elastic.co/guide/en/apm/guide/current/beats-api-keys.html#beats-api-key-es |
| } | ||
| ] | ||
| }, | ||
| "{beat_default_index_prefix}_sourcemap": { |
There was a problem hiding this comment.
tbh I'm not sure what's the point of this example, since the permissions are good enough to run apm-server with basic functionalities + rum but it is still lacking agentcfg role and monitoring role etc. I've updated this section so that it follows what's recommended in the updated RUM role. I'm wondering if we should expand this example to include all roles that allow apm-server to do everything it'll do but potentially making the doc hard to maintain, or stick with what we have now. In any case, this shouldn't block this PR.
There was a problem hiding this comment.
This example is about "Create an API key for writing events" and RUM source mapping kind of falls under it but at the same time not exactly.
There was a problem hiding this comment.
This is a good point. I think adding agent config makes sense. We should add it to both of the examples on this page (like you did with source maps). Monitoring I think we're okay to leave separate. It already has a separate section on this page.
There was a problem hiding this comment.
+1 on adding to the example;
but I don't think the index name is right .{beat_default_index_prefix}-source-map - shouldn't it be .apm-source-map?
There was a problem hiding this comment.
Effectively the doc compiles to .apm-source-map, but I agree that it is better to hardcode it.
There was a problem hiding this comment.
added agentcfg role to example.
There was a problem hiding this comment.
The changes look good;
overall the examples are outdated, as the indices do not start with apm* anymore, but with logs-*, metrics-*, traces-*. There is another issue to tackle this #10057 (comment), so if prefered, this can be tackled extra.
| } | ||
| ] | ||
| }, | ||
| "{beat_default_index_prefix}_sourcemap": { |
There was a problem hiding this comment.
+1 on adding to the example;
but I don't think the index name is right .{beat_default_index_prefix}-source-map - shouldn't it be .apm-source-map?
carsonip
changed the title
Let's tackle it separately, since it may have different backport targets. Multiple files may need to be updated and it is also important that we test it properly for the writer role. |
…11741) (#11896) * Document required privileges to read RUM source map from ES since 8.7. * Update API key creation examples, add agentcfg role to it. (cherry picked from commit 00fb30e) Co-authored-by: Carson Ip <[email protected]>
…11741) (#11899) * Document required privileges to read RUM source map from ES since 8.7. * Update API key creation examples, add agentcfg role to it. (cherry picked from commit 00fb30e) Co-authored-by: Carson Ip <[email protected]>
…11741) (#11897) * Document required privileges to read RUM source map from ES since 8.7. * Update API key creation examples, add agentcfg role to it. (cherry picked from commit 00fb30e) Co-authored-by: Carson Ip <[email protected]>
…11741) (#11898) * Document required privileges to read RUM source map from ES since 8.7. * Update API key creation examples, add agentcfg role to it. (cherry picked from commit 00fb30e) Co-authored-by: Carson Ip <[email protected]>
…11741) * Document required privileges to read RUM source map from ES since 8.7. * Update API key creation examples, add agentcfg role to it. (cherry picked from commit 00fb30e) # Conflicts: # docs/legacy/configuration-rum.asciidoc Signed-off-by: Carson Ip <[email protected]>
…les (backport #11741) (#11895) * docs: Document privileges to read RUM source maps; Update examples (#11741) * Document required privileges to read RUM source map from ES since 8.7. * Update API key creation examples, add agentcfg role to it. (cherry picked from commit 00fb30e) # Conflicts: # docs/legacy/configuration-rum.asciidoc Signed-off-by: Carson Ip <[email protected]> * Fix conflict Signed-off-by: Carson Ip <[email protected]> --------- Signed-off-by: Carson Ip <[email protected]> Co-authored-by: Carson Ip <[email protected]> Co-authored-by: Carson Ip <[email protected]>
Motivation/summary
Checklist
apmpackagehave been made)For functional changes, consider:
How to test these changes
Related issues
Closes #11722