Skip to content
This repository was archived by the owner on Sep 2, 2025. It is now read-only.
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
108 commits
Select commit Hold shift + click to select a range
d90fc06
[O11YDOCS-6514] Instrument browser applications
Feb 26, 2025
2e151d1
Moved the new file
Mar 14, 2025
9aea0b0
Added the new file to the toctree
Mar 14, 2025
d6abcd2
Updated
Mar 14, 2025
3c89536
Renamed the new file
Mar 14, 2025
c1a6819
Updated the title and filename
Mar 27, 2025
02fc548
Merge branch 'main' of github.com:splunk/private-o11y-docs into adasp…
Mar 27, 2025
d48bc6f
Updated the title and filename
Mar 27, 2025
4950a0a
Updated the headings
Mar 28, 2025
42ab241
Updated the filename
Mar 28, 2025
03d2331
Added placeholders
Mar 28, 2025
a3ae4c4
Added placeholders
Mar 31, 2025
352cba0
Added placeholders
Mar 31, 2025
b1a6c6c
Removed the note that Symbolication is not supported.
Mar 31, 2025
63bd533
Updated the RUM Android data model.
Mar 31, 2025
514e82d
Updated the RUM iOS data model.
Mar 31, 2025
b8380df
Fixed syntax error.
Mar 31, 2025
27fbcff
Updated to match doc input.
Apr 4, 2025
741c2d1
Updated the compatibility requirements for Splunk RUM for Mobile
Apr 14, 2025
abf95f5
Migrated content from Confluence
Apr 15, 2025
4877b69
Migrated content from Confluence
Apr 15, 2025
9814113
Migrated content from Confluence
Apr 15, 2025
d2b7116
Migrated content from Confluence
Apr 15, 2025
4e67598
Migrated content from Confluence
Apr 15, 2025
7bab03d
Migrated content from Confluence
Apr 15, 2025
4df7a59
Migrated content from Confluence
Apr 15, 2025
675aded
Migrated content from Confluence
Apr 15, 2025
baaaa70
Migrated content from Confluence
Apr 15, 2025
fc1dc69
Migrated content from Confluence
Apr 15, 2025
7cd6e1e
Migrated content from Confluence
Apr 15, 2025
e476435
Migrated content from Confluence
Apr 15, 2025
d0a1205
Migrated content from Confluence
Apr 15, 2025
4bfbd3e
Migrated content from Confluence
Apr 15, 2025
1d4434d
Migrated content from Confluence
Apr 15, 2025
f1af570
Migrated content from Confluence
Apr 15, 2025
8bf17f7
Reverted fix for configure-browser-instrumentation vs configure-rum-b…
Apr 15, 2025
dc6332b
Experiment with vs for codeblock syntax highlighting
Apr 15, 2025
d0bb159
Update gdi/get-data-in/rum/android/add-mapping-file.rst
adasplunk Apr 15, 2025
7db416f
Update gdi/get-data-in/rum/browser/set-up-javascript-source-mapping.rst
adasplunk Apr 15, 2025
1138eb3
Update gdi/get-data-in/rum/browser/set-up-javascript-source-mapping.rst
adasplunk Apr 15, 2025
ec83570
Update gdi/get-data-in/rum/ios/add-dsyms.rst
adasplunk Apr 15, 2025
d1fd8b5
Update gdi/get-data-in/rum/ios/add-dsyms.rst
adasplunk Apr 15, 2025
a361ddc
Update gdi/get-data-in/rum/ios/add-dsyms.rst
adasplunk Apr 15, 2025
d76dc02
Update rum/error-aggregates.rst
adasplunk Apr 15, 2025
98df4a3
Update rum/error-aggregates.rst
adasplunk Apr 15, 2025
ef8eb11
Update rum/error-aggregates.rst
adasplunk Apr 15, 2025
5ffef5c
Update rum/error-aggregates.rst
adasplunk Apr 15, 2025
a63c5af
Update rum/error-aggregates.rst
adasplunk Apr 15, 2025
0dfff9c
Update rum/error-aggregates.rst
adasplunk Apr 15, 2025
58c8eb5
Update rum/error-aggregates.rst
adasplunk Apr 16, 2025
a082fec
Incorporated changes from IX review.
Apr 16, 2025
56b1372
Incorporated changes from IX review.
Apr 16, 2025
cf71768
Promoted a couple headings where it didn't make sense to nest them.
Apr 16, 2025
60b2ce5
Reworded a sentence.
Apr 16, 2025
521765a
Removed an attribute from the Android and iOS RUM data models per Aditi.
Apr 16, 2025
46f3585
Corrected the Android prereq per Aditi
Apr 16, 2025
801510b
Corrected the Android stuff per Tony
Apr 16, 2025
e04e855
Fix capitalization issue
Apr 17, 2025
854d989
Updated based on reviewer feedback
Apr 23, 2025
cc62b8e
Updated based on reviewer feedback
Apr 23, 2025
eeca08c
Updated based on reviewer feedback
Apr 23, 2025
1f7a6cc
Updated based on reviewer feedback. Also updated Heretto (https://spl…
Apr 23, 2025
31b8192
WIP
aurbiztondo-splunk May 5, 2025
de0afea
Images
aurbiztondo-splunk May 5, 2025
5ca531c
Update
aurbiztondo-splunk May 5, 2025
c8a34be
Fixes
aurbiztondo-splunk May 5, 2025
e42f514
Feedback
aurbiztondo-splunk May 6, 2025
7dfeacd
Detail
aurbiztondo-splunk May 6, 2025
3ca4c3d
New table
aurbiztondo-splunk May 7, 2025
5777cf7
Remove CocoaPods references
May 13, 2025
f0c39b2
initial commit
mbechtold-splunk May 14, 2025
6543893
fixes
mbechtold-splunk May 14, 2025
55890a1
Add DWARF 4 build setting per Aditi
May 15, 2025
8d7ee9b
Exporters cofigurations added and note to SPLUNK_REALM
pkopta-splunk May 20, 2025
e3c25bf
fixed
pkopta-splunk May 20, 2025
94c28b1
error fixed
pkopta-splunk May 20, 2025
75f10e3
Updates based on SME requests
May 20, 2025
520cc69
Regions
aurbiztondo-splunk May 21, 2025
d51f165
Fix
aurbiztondo-splunk May 21, 2025
ec9b8b0
Address comments from GTM team
May 21, 2025
e95c7c9
Updates
aurbiztondo-splunk May 22, 2025
f964a36
Feedback
aurbiztondo-splunk May 22, 2025
c787d4f
service.name and deployment.environment info added
pkopta-splunk May 23, 2025
85ea550
update
pkopta-splunk May 23, 2025
0738384
fix indentation of code samples
bhillmer May 23, 2025
a0b29d1
Merge pull request #2790 from splunk/bhillmer-DOCGUILD-29606-doc-feed…
bhillmer May 23, 2025
125a548
Address comments from Santosh
May 23, 2025
f6d14bd
Whited out some usernames in a screenshot.
jcatera-splunk May 23, 2025
18dedfe
Made a little improvement.
jcatera-splunk May 23, 2025
fd189ec
Merge pull request #2791 from splunk/jcatera-DOCGUILD-29511
jcatera-splunk May 23, 2025
f791380
Merge pull request #2786 from splunk/pkopta_opt-in_support_added
pkopta-splunk May 26, 2025
dfa82d8
Latest updates
aurbiztondo-splunk May 27, 2025
358fd5a
Edits
aurbiztondo-splunk May 27, 2025
88ee2f9
More feedback
aurbiztondo-splunk May 27, 2025
7948267
Feedback
aurbiztondo-splunk May 27, 2025
8db7a8f
Fix
aurbiztondo-splunk May 27, 2025
82d5115
Address comments in GSO11Y-3367 and GSO11Y-3368
May 27, 2025
f5bb2c9
Merge pull request #2777 from splunk/mbechtold-atoule-ad-ds-receiver
mbechtold-splunk May 27, 2025
fc7b778
[Synthetics] Improve Run Result experience [RDMP-2972] [May 28 release]
May 27, 2025
92facb1
Fix syntax error
May 27, 2025
864e7d2
Address comments in GSO11Y-3367 and GSO11Y-3368
May 27, 2025
bae87f5
Fix syntax error
May 27, 2025
89b1c8d
Update synthetics/browser-test/browser-test-results.rst
adasplunk May 27, 2025
d36275b
Update synthetics/browser-test/browser-test-results.rst
adasplunk May 27, 2025
17da3ce
Update synthetics/browser-test/browser-test-results.rst
adasplunk May 27, 2025
899eab6
Merge pull request #2793 from splunk/adasplunk-O11YDOCS-7003
adasplunk May 27, 2025
b20fb38
Merge pull request #2651 from splunk/adasplunk-O11YDOCS-6514
adasplunk May 27, 2025
75b8df0
Merge pull request #2767 from splunk/urbiz-aws-pl-update
aurbiztondo-splunk May 29, 2025
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
Binary file added _images/gdi/AWS_PL_region1.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/gdi/AWS_PL_region1.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/gdi/AWS_PL_region2.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/gdi/AWS_PL_region3.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified _images/logs/CreateUser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions _includes/gdi/otel-receivers-table.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@
* - :ref:`apache-spark-receiver` (``apachespark``)
- Fetches metrics for an Apache Spark cluster through the Apache Spark REST API.
- Metrics
* - :ref:`activedirectory-ds-receiver` (``active_directory_ds``)
- Metrics
- Scrapes metrics relating to an Active Directory domain controller using the Windows Performance Counters.
* - :ref:`awsecscontainermetrics-receiver` (``awsecscontainermetrics``)
- Reads task metadata and docker stats from Amazon ECS and generates resource usage metrics.
- Metrics
Expand Down
2 changes: 1 addition & 1 deletion _includes/requirements/ios.rst
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Splunk RUM for Mobile supports the following versions:

* iOS 15 and higher
* iPadOS 13 and higher
* iPadOS 15 and higher

Splunk RUM supports Apple Silicon.
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following settings are specific to the Splunk Distribution of OpenTelemetry
* - ``SPLUNK_ACCESS_TOKEN``
- A Splunk authentication token that lets exporters send data directly to Splunk Observability Cloud. Unset by default. Not required unless you need to send data to the Splunk Observability Cloud ingest endpoint. See :ref:`admin-tokens`.
* - ``SPLUNK_REALM``
- The name of your organization's realm, for example, ``us0``. When you set the realm, telemetry is sent directly to the ingest endpoint of Splunk Observability Cloud, bypassing the Splunk Distribution of OpenTelemetry Collector.
- The name of your organization's realm, for example, ``us0``. When you set the realm, telemetry is sent directly to the ingest endpoint of Splunk Observability Cloud, bypassing the Splunk Distribution of OpenTelemetry Collector. This setting applies only to metrics and traces and does not work for logs.
* - ``SPLUNK_TRACE_RESPONSE_HEADER_ENABLED``
- Lets you add server trace information to HTTP response headers using the ``net/http`` instrumentation package. For more information, see :ref:`server-trace-information-go`. The default value is ``true``.
* - ``OTEL_LOG_LEVEL``
Expand Down Expand Up @@ -104,6 +104,8 @@ The following settings control trace exporters and their endpoints:
- The traces exporter to use. The default value is ``otlp``. Acceptable values are ``otlp`` and ``none``. Setting ``none`` deactivates trace exports.
* - ``OTEL_METRICS_EXPORTER``
- The metrics exporter to use. The default value is ``otlp``. Accepted values are ``otlp`` and ``none``. Setting ``none`` deactivates metric exports.
* - ``OTEL_LOGS_EXPORTER``
- The logs exporter to use. The default value is ``none``. Accepted values are ``otlp`` and ``none``. Setting ``none`` deactivates logs exports.
* - ``OTEL_METRIC_EXPORT_INTERVAL``
- Interval, in milliseconds, between the start of two export attempts. The default value is ``60000``.
* - ``OTEL_METRIC_EXPORT_TIMEOUT``
Expand All @@ -114,7 +116,9 @@ The following settings control trace exporters and their endpoints:
- The OTLP endpoint for traces. The default value is ``http://localhost:4317``.
* - ``OTEL_EXPORTER_OTLP_METRICS_ENDPOINT``
- The OTLP endpoint. The default value is ``http://localhost:4317``.

* - ``OTEL_EXPORTER_OTLP_LOGS_ENDPOINT``
- The OTLP endpoint. The default value is ``http://localhost:4317``.

To send data directly to Splunk Observability Cloud, see :ref:`export-directly-to-olly-cloud-go`.

.. _trace-sampling-settings-go-otel:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,9 @@ The following example shows how to update a deployment to expose environment var
Send data directly to Splunk Observability Cloud
==================================================================

By default, all telemetry is sent to the local instance of the Splunk Distribution of OpenTelemetry Collector.
By default, all telemetry is sent to the local OpenTelemetry Collector before being forwarded to Splunk Observability Cloud.
It is also possible to send data directly to Splunk Observability Cloud without using the OpenTelemetry Collector.
.. note:: Sending data directly to Splunk Observability Cloud is supported only for traces and metrics. Logs cannot be sent using this method.

If you need to send data directly to Splunk Observability Cloud, set the following environment variables:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -419,19 +419,19 @@ To deploy the .NET zero-code instrumentation in Kubernetes, follow these steps:

.. code-block:: shell

splunk-launch.sh dotnet <application>.
splunk-launch.sh dotnet <application>.

**For Windows:**

.. code-block:: powershell

splunk-launch.cmd dotnet <application>.
splunk-launch.cmd dotnet <application>.

Example:

.. code-block:: docker

ENTRYPOINT ["./splunk-launch.sh", "dotnet", "myapp.dll"]
ENTRYPOINT ["./splunk-launch.sh", "dotnet", "myapp.dll"]

#. Configure the Kubernetes Downward API to expose environment variables to Kubernetes resources. The following example demonstrates how to update a deployment to expose environment variables by adding the agent configuration under the ``.spec.template.spec.containers.env`` section:

Expand Down
249 changes: 249 additions & 0 deletions gdi/get-data-in/rum/android/add-mapping-file.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,249 @@
.. _add-mapping-file:

*********************************************************************
Add a mapping file
*********************************************************************


.. meta::
:description: Your uploaded mapping file enables Splunk RUM to convert stack traces back into a human-readable form.


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.

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.


.. note::
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>`.

Splunk RUM stores your mapping files permanently. You cannot delete them from Splunk RUM at this time.


Prerequisites
=====================================================================

* To support de-obfuscation of your application's stack traces, ensure that your ``proguard-rule.pro`` has the following two lines enabled:

.. code-block::

-keepattributes LineNumberTable,SourceFile
-renamesourcefileattribute SourceFile

* Upgrade the following Splunk components:

* :new-page:`splunk-otel-android<https://central.sonatype.com/artifact/com.splunk/splunk-otel-android>`: v1.10.0

* :ref:`Install the splunk-rum CLI<rum-gdi-install-cli>`.


Uploads for production builds
=====================================================================

#. Upload your application's mapping file and specify its ``applicationID`` and ``versionCode`` properties.

You can do this in either of these ways:

* Run the ``upload`` command with the ``--app-id`` and ``--version-code`` parameters:

.. note::
If you didn't set the ``SPLUNK_REALM`` and ``SPLUNK_ACCESS_TOKEN`` environment variables, you must also add the ``--realm <value>`` and ``--token <your-splunk-org-access-token>`` parameters to this command.

.. code-block:: shell

splunk-rum android upload \
--app-id=<applicationID> --version-code=<versionCode> \
--path=<path-to-mapping-file> \
[optional-parameters]

* Run the ``upload-with-manifest`` command with the path to the application's merged or packaged ``AndroidManifest.xml`` file, along with path to the mapping file. Be sure to include the correct manifest, which is the one that's created when your application is built, and is located in the build output directory:

.. note::
If you didn't set the ``SPLUNK_REALM`` and ``SPLUNK_ACCESS_TOKEN`` environment variables, you must also add the ``--realm <value>`` and ``--token <your-splunk-org-access-token>`` parameters to this command.

.. code-block:: shell

splunk-rum android upload-with-manifest \
--manifest <path-to-merged-manifest> \
--path <path-to-mapping-file> \
[optional-parameters]



#. (Optional) Verify that your upload succeeded:

.. code-block:: shell

splunk-rum android list --app-id=<applicationID>



Uploads for pre-production builds
=====================================================================

If you're instrumenting pre-production builds where ``versionCode`` isn't updated for each build, add a unique identifier as metadata to the ``AndroidManifest.xml`` file in your source directory before building the application binary. This identifier must be named ``splunk.build_id``. To add this identifier, follow the steps below:


#. Add this snippet to the ``<application>`` block of the ``AndroidManifest.xml`` file in your source directory:

.. code-block:: xml

<meta-data
android:name="splunk.build_id"
android:value="${splunkBuildId}" />


#. Add the following code to the ``android {}`` block of the Gradle build script of your application. This code generates a new UUID for every application variant and adds it to the merged manifest file after the variant is assembled, where the Splunk RUM agent will retrieve it:

* If you use Kotlin add this to ``build.gradle.kts``:

.. code-block::

applicationVariants.configureEach {
val uniqueBuildId = UUID.randomUUID().toString()
this.mergedFlavor.manifestPlaceholders["splunkBuildId"] = uniqueBuildId

logger.lifecycle("Splunk: Variant $name assigned build ID: $uniqueBuildId")

val capitalizedVariantName = name.replaceFirstChar { it.uppercase() }
tasks.named("process${capitalizedVariantName}Manifest").configure {
outputs.upToDateWhen { false }
}
}


* If you use Groovy add this to ``build.gradle``:

.. code-block::

applicationVariants.configureEach { variant ->
def uniqueBuildId = UUID.randomUUID().toString()
variant.mergedFlavor.manifestPlaceholders.put("splunkBuildId", uniqueBuildId)

project.logger.lifecycle("Splunk: Variant ${variant.name} assigned build ID: ${uniqueBuildId}")

def capitalizedVariantName = variant.name.capitalize()
tasks.named("process${capitalizedVariantName}Manifest").configure {
outputs.upToDateWhen { false }
}
}


#. Upload your application's mapping file and specify its ``applicationID`` , ``versionCode``, and ``splunk.build_id`` properties. You can do this in either of these ways:

* Run the upload command with the ``--app-id``, ``--version-code``, and ``--splunk-build-id`` parameters. This option only works if you added ``splunk.build_id`` to your Gradle build script (in step 1). Get the build ID from the Gradle build output or from the merged manifest:

.. note::
If you didn't set the ``SPLUNK_REALM`` and ``SPLUNK_ACCESS_TOKEN`` environment variables, you must also add the ``--realm <value>`` and ``--token <your-splunk-org-access-token>`` parameters to this command.

.. code-block:: shell

splunk-rum android upload \
--app-id=<applicationID> --version-code=<versionCode> \
--splunk-build-id <value> \
--path=<path-to-mapping-file> \
[optional-parameters]


* Run the ``upload-with-manifest`` command with the path to the application's merged or packaged ``AndroidManifest.xml`` file, along with path to the mapping file. Be sure to include the correct manifest, which is the one that's created when your application is built, and is located in the build output directory:

.. note::
If you didn't set the ``SPLUNK_REALM`` and ``SPLUNK_ACCESS_TOKEN`` environment variables, you must also add the ``--realm <value>`` and ``--token <your-splunk-org-access-token>`` parameters to this command.

.. code-block:: shell

splunk-rum android upload-with-manifest \
--manifest <path-to-merged-manifest> \
--path <path-to-mappping-file> \
[optional-parameters]


#. (Optional) Verify that your upload succeeded:

.. code-block:: shell

splunk-rum android list --app-id=<applicationID>



Syntax
=====================================================================

.. code-block:: shell

splunk-rum android [command] [parameters]



Command descriptions
=====================================================================

.. list-table::
:header-rows: 1
:widths: 20, 80

* - :strong:`Command`
- :strong:`Description`

* - ``upload --path <path> --app-id <value> --version-code <int> [optional-parameters]``
- Upload the mapping file ``mapping.txt`` with the application ID and version code that you specify.

Parameters:

* ``--path <path>`` Required. Path to the ``mapping.txt`` file.

* ``--app-id <applicationID>`` Required. The ``applicationId`` property in your application's ``build.gradle`` file.

* ``--version-code <int>`` Required. The ``versionCode`` property of your application.

* ``--splunk-build-id <value>`` Optional. Splunk build ID for the upload.

* ``--realm <value>`` Optional. Realm for your organization. For example, ``us0``. You can omit this parameter and set the environment variable ``SPLUNK_REALM`` instead.

* ``--token <your-splunk-org-access-token>`` Optional. API access token. You can omit this parameter and set the environment variable ``SPLUNK_ACCESS_TOKEN`` instead.

* ``--dry-run=[true|false]`` Perform a trial run with no changes made. Default: ``false``.

* ``--debug`` Enable debug logs.

* ``-h, --help`` Display help for this command.


* - ``upload-with-manifest --manifest <path> --path <path> [optional-parameters]``
- Upload the Android ``mapping.txt`` file with required metadata extracted from the ``AndroidManifest.xml`` file.

Parameters:

* ``--manifest <path>`` Required. Path to the merged or the packaged ``AndroidManifest.xml`` file that is generated when the application is built.

* ``--path <path>`` Required. Path to the ``mapping.txt`` file.

* ``--realm <value>`` Optional. Realm for your organization. For example, ``us0``. You can omit this parameter and set the environment variable ``SPLUNK_REALM`` instead.

* ``--token <your-splunk-org-access-token>`` Optional. API access token. You can omit this parameter and set the environment variable ``SPLUNK_ACCESS_TOKEN`` instead.

* ``--dry-run=[true|false]`` Preview the file that will be uploaded and the parameters that will be extracted from ``AndroidManifest.xml``.

* ``--debug`` Enable debug logs.

* ``-h, --help`` Display help for command.


* - ``list --app-id <value> [optional-parameters]``
- List the 100 most recently uploaded mapping files for the given application ID, sorted in reverse chronological order based on the upload timestamp.

Parameters:

* ``--app-id <applicationID>`` Required. The ``applicationId`` property in your app's ``build.gradle`` file.

* ``--realm <value>`` Optional. Realm for your organization. For example, ``us0``. You can omit this parameter and set the environment variable ``SPLUNK_REALM`` instead.

* ``--token <your-splunk-org-access-token>`` Optional. API access token. You can omit this parameter and set the environment variable ``SPLUNK_ACCESS_TOKEN`` instead.

* ``--dry-run=[true|false]`` Perform a trial run with no changes made. Default: ``false``.

* ``--debug`` Enable debug logs.

* ``-h, --help`` Display help for this subcommand.


1 change: 1 addition & 0 deletions gdi/get-data-in/rum/android/get-android-data-in.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ Instrument Android applications for Splunk RUM
Configure the instrumentation <configure-rum-android-instrumentation>
Manually instrument applications <manual-rum-android-instrumentation>
Android RUM data model <rum-android-data-model>
Add a mapping file <add-mapping-file>
Troubleshooting <troubleshooting>

Instrument your Android applications to get Real User Monitoring (RUM) data into Splunk Observability Cloud. With Splunk RUM for Mobile, you can gain insight about the performance and health of your mobile apps.
Expand Down
11 changes: 9 additions & 2 deletions gdi/get-data-in/rum/android/rum-android-data-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -228,9 +228,16 @@ The Android RUM agent adds the following crash reporting attributes to spans tha
* - ``component``
- String
- Always ``crash``.
* - ``status``
* - ``service.application_id``
- String
- Application ID of the app: Refer to definition of ``applicationId`` in the :new-page:`Android Studio developer documentation <https://developer.android.com/build/configure-app-module#set-application-id>`.
* - ``service.version_code``
- String
- Always ``Error``.
- Version code of the application: Refer to definition of ``versionCode`` in the :new-page:`Android Studio developer documentation <https://developer.android.com/studio/publish/versioning#versioningsettings>`.
* - ``splunk.build_id``
- String
- This is an optional attribute. This is added when minification is enabled for pre-production builds where version code is not updated across app builds, in which case this attribute is used to uniquely identify each build.


Network monitoring
----------------------------------------------------
Expand Down
1 change: 1 addition & 0 deletions gdi/get-data-in/rum/browser/get-browser-data-in.rst
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ Instrument browser-based web applications for Splunk RUM
Migrate manual instrumentation <migrate-manual-instrumentation>
Data collected <rum-browser-data-model>
Instrumentation-specific data <browser-rum-instrumentations>
Set up JavaScript source mapping <set-up-javascript-source-mapping>
Errors collected <browser-rum-errors>
API reference <browser-rum-api-reference>
Troubleshooting <troubleshooting>
Expand Down
11 changes: 11 additions & 0 deletions gdi/get-data-in/rum/browser/rum-browser-data-model.rst
Original file line number Diff line number Diff line change
Expand Up @@ -229,6 +229,17 @@ The browser agent sends the IP addresses of all beacon connections to Splunk Obs

.. note:: Splunk Observability Cloud calculates only geographical metadata from the IPs, and drops IP addresses within 6 hours.


Additions to the RUM browser model by splunk-rum
========================================================
If you're using the ``splunk-rum`` CLI or the Webpack build plugin to upload your source map, those tools will add a new attribute named ``error.sourceMapIds`` to your RUM browser data model. This attribute contains a mapping of file URL and ``sourceMapId`` pairs, where:

* You must have already injected the ``sourceMapId`` attribute into your source map (using the ``splunk-rum`` CLI or the Webpack build plugin). See :ref:`set-up-javascript-source-mapping`.
* Only files mentioned in the error's ``error.stack`` appear in ``error.sourceMapIds``.

This attribute is only in your RUM browser data model if you're using the ``splunk-rum`` CLI or the Webpack build plugin.


Instrumentation-specific data
==============================================

Expand Down
Loading