-
Notifications
You must be signed in to change notification settings - Fork 169
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Update source map documentation #3354
Comments
Hi team, I was just now looking at the docs: https://www.elastic.co/guide/en/kibana/current/rum-sourcemap-api.html#apm-sourcemap-post-example and I saw something that is wrong (it has been wrong for a while it seems and it causes a lot of confusion among customers) The code example shows "/test/e2e/general-usecase/bundle.js.map"' which is the sourcemap file and that's incorrect. The value for that property should be the file/bundle used in the website. We can see the proper code example here: https://www.elastic.co/guide/en/apm/guide/current/source-map-how-to.html#source-map-rum-upload Edit: the same thing happens here: https://www.elastic.co/guide/en/kibana/current/rum-sourcemap-api.html#apm-sourcemap-get-body Let me know if I can do anything to help with this Thanks, |
Hi @colleenmcginnis, @bmorelli25, I created a PR related to the previous comment. Let me know if there is something missing Thanks!! |
Part of elastic/observability-docs#3354 (comment) ## Summary `bundle_filepath` should not contain `.map`.
Part of elastic/observability-docs#3354 (comment) ## Summary `bundle_filepath` should not contain `.map`. (cherry picked from commit 128506c)
# Backport This will backport the following commits from `main` to `8.12`: - [[Docs] remove .map from bundle_filepath value (#174834)](#174834) <!--- Backport version: 9.4.3 --> ### Questions ? Please refer to the [Backport tool documentation](https://github.com/sqren/backport) <!--BACKPORT [{"author":{"name":"Alberto Delgado Roda","email":"[email protected]"},"sourceCommit":{"committedDate":"2024-01-16T16:59:23Z","message":"[Docs] remove .map from bundle_filepath value (#174834)\n\nPart of\r\nhttps://github.com/elastic/observability-docs/issues/3354#issuecomment-1849730927\r\n\r\n## Summary\r\n\r\n`bundle_filepath` should not contain `.map`.","sha":"128506c65291562af3ff71a515333af63a05e70a","branchLabelMapping":{"^v8.13.0$":"main","^v(\\d+).(\\d+).\\d+$":"$1.$2"}},"sourcePullRequest":{"labels":["release_note:skip","backport:prev-minor","v8.13.0"],"title":"[Docs] remove .map from bundle_filepath value","number":174834,"url":"https://github.com/elastic/kibana/pull/174834","mergeCommit":{"message":"[Docs] remove .map from bundle_filepath value (#174834)\n\nPart of\r\nhttps://github.com/elastic/observability-docs/issues/3354#issuecomment-1849730927\r\n\r\n## Summary\r\n\r\n`bundle_filepath` should not contain `.map`.","sha":"128506c65291562af3ff71a515333af63a05e70a"}},"sourceBranch":"main","suggestedTargetBranches":[],"targetPullRequestStates":[{"branch":"main","label":"v8.13.0","branchLabelMappingKey":"^v8.13.0$","isSourceBranch":true,"state":"MERGED","url":"https://github.com/elastic/kibana/pull/174834","number":174834,"mergeCommit":{"message":"[Docs] remove .map from bundle_filepath value (#174834)\n\nPart of\r\nhttps://github.com/elastic/observability-docs/issues/3354#issuecomment-1849730927\r\n\r\n## Summary\r\n\r\n`bundle_filepath` should not contain `.map`.","sha":"128506c65291562af3ff71a515333af63a05e70a"}}]}] BACKPORT--> Co-authored-by: Alberto Delgado Roda <[email protected]>
Part of elastic#3354 (comment) ## Summary `bundle_filepath` should not contain `.map`.
Part of elastic#3354 (comment) ## Summary `bundle_filepath` should not contain `.map`.
Summary
APM Server and RUM agent source map documentation is woefully out of date. There are numerous open issues with recommended updates.
General updates
There's some really good info and links in the above issue descriptions. Additional information can be found in the following recently updated config docs:
RUM custom app example
I'm not sure how feasible it is for a writer to update this example. The example app hasn't been updated in at least three years. I tried and couldn't figure it out.
The text was updated successfully, but these errors were encountered: