Skip to content
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.

Sign up for GitHub

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

[8.8] docs: Update source map documentation (backport #12131) #12153

Merged
merged 1 commit into from
Dec 4, 2023
Merged

[8.8] docs: Update source map documentation (backport #12131) #12153

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 3 additions & 7 deletions apm-server.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,14 +170,10 @@ apm-server:
# Note that values configured without a time unit will be interpreted as seconds.
#cache.expiration: 5m

# Source maps may be fetched from Elasticsearch by using the output.elasticsearch configuration,
# and running apm-server standalone.
# Source map retrieval location.
#
# Note: fetching source maps from Elasticsearch is not supported if apm-server is being managed by
# Fleet. This configuration is only applicable to standalone apm-servers, for backwards compatibility
# with source maps stored in Elasticsearch by older versions of apm-server. New source maps must now
# be uploaded via Kibana, and `apm-server.kibana` configured in standalone apm-servers for fetching
# them.
# If using an output other than Elasticsearch that is writing to Elasticsearch, you must
# set this option. If not set, the standard output elasticsearch configuration is used.
#elasticsearch:
# Array of hosts to connect to.
# Scheme and port can be left out and will be set to the default (`http` and `9200`).
Expand Down
23 changes: 17 additions & 6 deletions docs/source-map-how-to.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,19 +95,21 @@ module.exports = {

[float]
[[source-map-rum-upload]]
=== Upload the source map to {kib}
=== Upload the source map

TIP: When uploading a source map, ensure that RUM support is enabled in the APM integration.

{kib} exposes a {kibana-ref}/rum-sourcemap-api.html[source map endpoint] for uploading source maps.
Source maps can be uploaded as a string, or as a file upload.
Before uploading a source map, ensure that RUM support is enabled in the APM integration

Let's look at two different ways to upload a source map: curl and a custom application.
Each example includes the four fields necessary for APM Server to later map minified code to its source:

* `service_name` - Should match the `serviceName` from step one
* `service_version` - Should match the `serviceVersion` from step one
* `bundle_filepath` - The absolute path of the final bundle as used in the web application
* `sourcemap` - The location of the source map.
* `service_name`: Should match the `serviceName` from step one.
* `service_version`: Should match the `serviceVersion` from step one.
* `bundle_filepath`: The absolute path of the final bundle as used in the web application.
* `sourcemap`: The location of the source map.

If you have multiple source maps, you'll need to upload each individually.

[float]
Expand Down Expand Up @@ -164,3 +166,12 @@ request.post({url: 'http://localhost:5601/api/apm/sourcemaps',formData: formData
}
})
----

[float]
[[source-map-next]]
=== What happens next

Source maps are stored in {es}. When you upload a source map, a new {es} document is created
containing the contents of the source map.
When a RUM request comes in, APM Server will make use of these source map documents to apply the
source map logic to the event's stack traces.