search

elastic / observability-docs

Elastic Observability Documentation
Other
36 stars 164 forks source link

Update source map documentation #3354

Open bmorelli25 opened 1 year ago

bmorelli25 commented 1 year ago

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.

devcorpio commented 11 months ago

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)

Screenshot 2023-12-11 at 11 00 57

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, Alberto

devcorpio commented 10 months ago

Hi @colleenmcginnis, @bmorelli25,

I created a PR related to the previous comment.

Let me know if there is something missing

Thanks!!