Use splunk-rum for production builds

Follow these steps to specify the --app-id and --version-code parameters on the splunk-rum android upload command or include your application's merged or packaged manifest (AndroidManifest.xml), which includes these properties by default, in the splunk-rum android upload-with-manifest command.

1. Confirm that your setup meets these prerequisites:

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

     -keepattributes LineNumberTable,SourceFile
     -renamesourcefileattribute SourceFile

   • Upgrade your Splunk RUM Android agent:

     • splunk-otel-android: v2.0.0

   • Install the splunk-rum CLI.

2. Build your application.

3. 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:

     splunk-rum android upload \
     --app-id=applicationID --version-code=versionCode \
     --path=path-to-mapping-file \
     [optional-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.

   • 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.

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

4. (Optional) Verify that your upload succeeded:

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

Use splunk-rum for pre-production builds

1. Confirm that your setup meets these prerequisites:

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

     -keepattributes LineNumberTable,SourceFile
     -renamesourcefileattribute SourceFile

   • Upgrade your Splunk RUM Android agent:

     • splunk-otel-android: v2.0.0

   • Install the splunk-rum CLI.

2. Since pre-production builds don't update the versionCode property for each build, add a unique identifier named splunk.build_id as metadata to the AndroidManifest.xml file in your source directory before building the application binary:

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

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

   2. 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:

      Kotlin

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

      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 }
          }
      }
      

      Groovy

      If you use Groovy add this to build.gradle:

      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 }
          }
      }
      

3. Build your application.

4. 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:

     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:

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

5. (Optional) Verify that your upload succeeded:

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

splunk-rum syntax

splunk-rum android [command] [parameters]

splunk-rum command descriptions

Use the Splunk RUM Gradle plugin

If you obfuscated your production build, you can automatically upload mapping files and inject build correlation IDs using the Splunk RUM Gradle plugin:

• Add the plugin to your application-level build.gradle or build.gradle.kts:

  Kotlin DSL

  plugins {
      id("com.splunk.rum-mapping-file-plugin") version "2.0.0"
  }

  Groovy

  plugins {
      id 'com.splunk.rum-mapping-file-plugin' version '2.0.0'
  }

• Configure the extension block in your application-level build.gradle or build.gradle.kts:

  splunkRum {
      enabled = true
      realm = "your-realm"  
      apiAccessToken = "your-api-access-token-here"
      failBuildOnUploadFailure = false
  }

• Build your application. The plugin automatically:

  • Generates a unique build ID for each variant with minification enabled.

  • Injects the build ID into your app's manifest for runtime correlation by the agent.

  • Uploads the mapping file after a successful build.