Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.

Commit ec9b8b0

Browse files
author
ada
committed
Address comments from GTM team
1 parent 75f10e3 commit ec9b8b0

File tree

4 files changed

+20
-9
lines changed

4 files changed

+20
-9
lines changed

gdi/get-data-in/rum/android/add-mapping-file.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,13 @@ Add a mapping file
1111

1212
When you set the ``minifyEnabled`` property to true in your Android application source code, your build process minifies, optimizes, and obfuscates the code and generates a single mapping file, ``mapping.txt``. This mapping file contains the information Splunk RUM needs to convert stack traces containing obfuscated classes and filenames back into a human readable form. This conversion is called deobfuscation in Android.
1313

14+
In order to associate a specific mapping file with a specific application build, Splunk RUM compares the ``applicationId`` and ``versionCode`` properties of the application to the parameters that you specify for the mapping file upload. You specify these parameters either as ``--app-id`` and ``--version-code`` in the ``splunk-rum android upload`` command or by including your application's merged or packaged manifest (``AndroidManifest.xml``), which includes these properties by default, in the ``splunk-rum android upload-with-manifest`` command.
1415

15-
.. note::
16-
Make sure that the mapping file you upload to Splunk RUM matches the binary you deploy to production. To ensure this, the best practice is to integrate the ``splunk-rum`` usage into your CI pipeline so that whenever you re-build your Android application, you also re-upload its mapping file.
1716

17+
.. note::
18+
Splunk recommends that you follow the steps on this page to upload your mapping files to Splunk RUM before you distribute corresponding binaries. To ensure that the mapping files you upload to Splunk RUM match the binaries you deploy to production, the best practice is to integrate the ``splunk-rum`` commands below into your CI pipeline so that whenever you re-build your Android application, you automatically re-upload its mapping file. Alternatively, you can :ref:`upload source maps on demand<mobile-connect-source-files>`.
1819

19-
In order to associate a specific mapping file with a specific application build, Splunk RUM compares the ``applicationId`` and ``versionCode`` properties of the application to the parameters that you specify for the mapping file upload. You specify these parameters either as ``--app-id`` and ``--version-code`` in the ``splunk-rum android upload`` command or by including your application's merged or packaged manifest (``AndroidManifest.xml``), which includes these properties by default, in the ``splunk-rum android upload-with-manifest`` command.
20+
Splunk RUM stores your mapping files permanently. You cannot delete them from Splunk RUM at this time.
2021

2122

2223
Prerequisites

gdi/get-data-in/rum/browser/set-up-javascript-source-mapping.rst

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,16 @@ Setting up JavaScript source mapping involves these steps:
1919
* Deploying your minified files to your production environment.
2020

2121

22+
.. note::
23+
Splunk recommends that you follow the steps on this page to upload your source maps to Splunk RUM before you distribute corresponding binaries. To ensure this, the best practice is to integrate these steps into your CI pipeline so that whenever you build your application, your pipeline automatically uploads the corresponding source maps to Splunk RUM. Alternatively, you can :ref:`upload source maps on demand<browser-connect-source-maps>`.
24+
25+
Splunk RUM stores your source maps permanently. You cannot delete them from Splunk RUM at this time.
26+
27+
2228
Prerequisites
2329
=====================================================================
2430

25-
* Update your browser RUM agent to v0.19.2 or later. Otherwise, Splunk RUM can't symbolicate stack traces from browser apps.
31+
* Update your browser RUM agent (``splunk-otel-web.js``) to v0.20.2 or later. Otherwise, Splunk RUM can't symbolicate stack traces from browser apps.
2632
* :ref:`Install the splunk-rum CLI<rum-gdi-install-cli>`.
2733

2834

gdi/get-data-in/rum/ios/add-dsyms.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ When you build your iOS application in release mode, your build process generate
1414

1515
The ``splunk-rum`` CLI compresses dSYM directories into ``.zip`` files for you and uploads them. When you upload a zipped dSYM to Splunk RUM, you enable Splunk RUM to symbolicate the debug symbols contained within that dSYM. This in turn enables you to view stack traces with the names of functions and offsets into those functions to help you identify the line of code that was executing when the application crashed.
1616

17-
You can upload dSYMs from your main application code and from third-party frameworks, but not from system libraries. Splunk RUM does not yet support the symbolication of stack frames for system libraries.
17+
You can upload dSYMs from your main application code and from third-party frameworks. Splunk RUM does not yet support the symbolication of stack frames for system libraries.
1818

1919

2020
Prerequisites
@@ -48,7 +48,9 @@ Upload dSYMs
4848
To upload dSYMs use the ``splunk-rum`` CLI as follows.
4949

5050
.. note::
51-
Splunk recommends that you upload dSYMs to Splunk RUM before you distribute corresponding binaries. To ensure this, the best practice is to integrate the ``splunk-rum`` CLI into your CI pipeline so that whenever you archive your iOS application, your pipeline uploads the corresponding dSYMs to Splunk RUM.
51+
Splunk recommends that you upload dSYMs to Splunk RUM before you distribute corresponding binaries. To ensure this, the best practice is to integrate the following ``splunk-rum`` commands into your CI pipeline so that whenever you archive your iOS application, your pipeline automatically uploads the corresponding dSYMs to Splunk RUM. Alternatively, you can :ref:`upload dSYMs on demand<mobile-connect-source-files>`.
52+
53+
Splunk RUM stores your dSYMs permanently. You cannot delete them from Splunk RUM at this time.
5254

5355

5456
#. Upload your application's dSYMs:

rum/error-aggregates.rst

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -94,10 +94,11 @@ To learn more about Tag Spotlight, see:
9494
Connect source files
9595
------------------------------------------------------------------------------------------
9696

97-
The information in most raw crash stack traces is not fully human-readable. To make a stack trace readable, you must provide platform-specific mapping information that translates that stack trace into human-readable form:
97+
The information in most raw crash stack traces is not fully human-readable. To make a stack trace readable, you must provide platform-specific mapping information that translates that stack trace into human-readable form. You can either upload mapping information now ("on-demand”) or at the time that you instrument your mobile application:
9898

99+
100+
* To upload mapping files now, select :guilabel:`Add dSYMs` for iOS applications or :guilabel:`Add a mapping file` for Android applications on this dashboard.
99101
* To upload mapping files at instrumentation time, see :ref:`add-dsyms` for iOS applications or :ref:`add-mapping-file` for Android applications.
100-
* To upload mapping files using the widget on this dashboard, select :guilabel:`Add dSYMs` for iOS applications or :guilabel:`Add a mapping file` for Android applications.
101102

102103

103104

@@ -115,13 +116,14 @@ To see errors from a specific browser application:
115116

116117

117118

118-
.. _browser-connect-source-files:
119+
.. _browser-connect-source-maps:
119120

120121
Upload source maps for readable stack traces
121122
------------------------------------------------------------------------------------------
122123

123124
The information in most raw stack traces is not fully human readable. To make your raw stack traces easier for you to read, you need to provide source maps that correspond to this browser application. Source maps enable Splunk RUM to translate raw stack traces back into a human-readable form. You can either upload source maps now ("on-demand”) or at the time that you instrument your browser application:
124125

126+
125127
* To upload source maps now, select :guilabel:`Upload` on this dashboard.
126128
* To upload source maps at instrumentation time, see :ref:`set-up-javascript-source-mapping`.
127129

0 commit comments

Comments
 (0)