Merge pull request #2566 from splunk/adasplunk-O11YDOCS-6779

[O11YDOCS-6779] Deprecation notice for iOS and Android instrumentation APIs [Feb 4 release]

Author: adasplunk

_includes/requirements/android.rst

@@ -1 +1 @@
-Splunk RUM for Mobile supports Java and Kotlin applications for Android API Level 21 and higher. API levels 21 to 25 require core library desugaring activated. See :ref:`enable-desugaring`.
+Splunk RUM for Mobile supports Java and Kotlin applications for Android API level 21 and higher. API levels 21 to 25 require core library desugaring activated. See :ref:`enable-desugaring`. Android 7.0 (also known as Nougat) corresponds to API level 24.

_includes/requirements/ios.rst

@@ -1,6 +1,6 @@
 Splunk RUM for Mobile supports the following versions:
 
-* iOS 11 and higher
+* iOS 15 and higher
 * iPadOS 13 and higher
 
 Splunk RUM supports Apple Silicon.

gdi/get-data-in/rum/android/configure-rum-android-instrumentation.rst

@@ -65,7 +65,7 @@ Use the following settings to configure the Android RUM agent:
    * - :code:`enableDebug()`
      - Activates debug mode. This feature is inactive by default. Activating debug mode activates the OpenTelemetry logging span exporter, which might be useful when debugging instrumentation issues.
    * - :code:`enableExperimentalOtlpExporter()`
-     - Activates the experimental OTLP exporter. The exporter is not compatible with disk buffering.
+     - Activates the experimental OTLP exporter. The exporter is not compatible with disk buffering. ``enableExperimentalOtlpExporter()`` is deprecated in Splunk RUM as of February 4, 2025. Although ``enableExperimentalOtlpExporter()`` continues to function, it will be removed in a future version, where OTLP will be the default exporter format. 
 
 .. _android-rum-instrumentation-settings:
 
@@ -105,6 +105,9 @@ The Android RUM agent includes instrumentation for the OkHttp and Volley HTTP cl
 OkHttp
 -----------------------------------------------
 
+.. note:: 
+   This form of support for OkHttp is deprecated in Splunk RUM as of February 4, 2025. Although ``createRumOkHttpCallFactory(OkHttpClient client)`` continues to function, it will be removed in a future version, and replaced with an option for automatic instrumentation of OkHttp3 or a new API for manual instrumentation. 
+
 Instrument OkHttp using the ``Call.Factory`` wrapper, as in the following example:
 
 .. code-block:: java
@@ -116,6 +119,9 @@ Instrument OkHttp using the ``Call.Factory`` wrapper, as in the following exampl
 Volley HTTP (Experimental)
 -------------------------------------------------
 
+.. note:: 
+  All methods in ``VolleyTracing`` and ``VolleyTracingBuilder`` are deprecated in Splunk RUM as of February 4, 2025. Although these methods continue to function, they will be removed in a future version. There is no replacement for these methods. 
+
 To instrument Volley HTTP, add the ``splunk-otel-android-volley`` dependency to the ``build.gradle.kts`` file:
 
 .. code-block:: java

gdi/get-data-in/rum/android/install-rum-android.rst

@@ -20,7 +20,7 @@ To instrument your Android application and get data into Splunk RUM, follow the
 Decide which version to run in your environment
 =======================================================
 
-Latest updates automatically whenever Splunk RUM releases a new version. In pre-production, use latest to try out the most recent version of Splunk RUM. In production environments, use the pinned version which was previously tested in pre-production and update the production version on a monthly cycle.
+The latest version updates automatically whenever Splunk RUM releases a new version. In pre-production, use ``latest`` to try out the most recent version of Splunk RUM. In production environments, use the pinned version which was previously tested in pre-production and update the production version on a monthly cycle. 
 
 
 Check compatibility and requirements
@@ -194,6 +194,10 @@ Follow these steps to install the Android RUM agent using Maven Central:
 
    See :ref:`android-rum-http-client-settings` for more information.
 
+   .. note:: 
+      This form of support for OkHttp is deprecated in Splunk RUM as of February 4, 2025. Although ``createRumOkHttpCallFactory(OkHttpClient client)`` continues to function, it will be removed in a future version, and replaced with an option for automatic instrumentation of OkHttp3 or a new API for manual instrumentation. 
+
+
 5. Release the changes to the Android application.
 
 6. Generate some user activity in your application. After you've interacted with the application, verify that the data is appearing in the RUM dashboard.

gdi/get-data-in/rum/android/manual-rum-android-instrumentation.rst

@@ -143,6 +143,9 @@ The following example shows how to start a workflow for which metrics are record
 Customize screen names
 =====================================
 
+.. note:: 
+   The ``@RumScreenName`` annotation is deprecated in Splunk RUM as of February 4, 2025. Although this annotation continues to function, it will be removed in a future version. There is no replacement for this annotation. 
+
 By default, the Android RUM agent uses the simple class name of each ``Fragment`` and ``Activity`` type as the value of the ``screen.name`` attribute. To customize the screen name, use the ``@RumScreenName`` annotation.
 
 For example, the following activity appears with the ``screen.name`` attribute set to the value ``Buttercup``:

gdi/get-data-in/rum/ios/configure-rum-ios-instrumentation.rst

@@ -21,7 +21,6 @@ The following example shows how to configure the RUM token, realm, environment n
       //..
       SplunkRumBuilder(realm: "<realm>", rumAuth: "<rum-token>")
         // Call functions to configure additional options
-        .allowInsecureBeacon(enabled: true)
         .debug(enabled: true)
         .globalAttributes(globalAttributes: ["strKey": "strVal", "intKey": 7, "doubleKey": 1.5, "boolKey": true])
         .deploymentEnvironment(environment: "env")
@@ -37,7 +36,6 @@ The following example shows how to configure the RUM token, realm, environment n
       //...
 
       SplunkRumBuilder *builder = [[SplunkRumBuilder alloc] initWithBeaconUrl:@"https://rum-ingest.<realm>.signalfx.com/v1/rum"  rumAuth: @"<rum-token>"]];
-      [builder allowInsecureBeaconWithEnabled:true];
       [builder globalAttributesWithGlobalAttributes:[NSDictionary dictionary]];
       [builder debugWithEnabled:true];
       [builder deploymentEnvironmentWithEnvironment:@"environment-name"];
@@ -94,13 +92,13 @@ Use the following settings to configure the behavior of iOS RUM instrumentation:
    * - :code:`sessionSamplingRatio`
      - Percentage of sessions to sample. Expressed as a proportion in the range ``0.0`` to ``1.0``. The default value is ``1.0``.
    * - :code:`allowInsecureBeacon`
-     - If set to ``true``, this setting allows beacon URLs that use the HTTP protocol. The default value is ``false``.
+     - If set to ``true``, this setting allows beacon URLs that use the HTTP protocol. The default value is ``false``. ``allowInsecureBeacon`` is deprecated in Splunk RUM as of February 4, 2025. Although this setting continues to function, it will be removed in a future version. 
    * - :code:`enableDiskCache`
-     - Activates caching of exported spans. All spans are written to local storage and deleted after a successful export. The default value is ``false``.
+     - Activates caching of exported spans. All spans are written to local storage and deleted after a successful export. The default value is ``false``. This setting is deprecated in Splunk RUM as of February 4, 2025. Although this setting continues to function, it will be removed in a future version. There is no replacement for this annotation. 
    * - :code:`spanDiskCacheMaxSize`
-     - Threshold, in megabytes, from which spans start to be dropped from the disk cache. The oldest spans are dropped first. Only applicable when disk caching is activated. The default value is ``25`` megabytes.
+     - Threshold, in megabytes, from which spans start to be dropped from the disk cache. The oldest spans are dropped first. Only applicable when disk caching is activated. The default value is ``25`` megabytes. This setting is deprecated in Splunk RUM as of February 4, 2025. Although this setting continues to function, it will be removed in a future version. There is no replacement for this annotation. 
    * - :code:`bspScheduleDelay`
-     - Sets the maximum interval between two consecutive span exports. The default value is 5 seconds.
+     - Sets the maximum interval between two consecutive span exports. The default value is 5 seconds. This setting is deprecated in Splunk RUM as of February 4, 2025. Although this setting continues to function, it will be removed in a future version. There is no replacement for this annotation. 
    * - :code:`slowRenderingDetectionEnabled`
      - Activates the slow rendering detection feature. The default value is ``true``. See :ref:`ios-slow-rendering-data`.
    * - :code:`slowFrameDetectionThresholdMs`

gdi/get-data-in/rum/ios/install-rum-ios.rst

@@ -91,21 +91,6 @@ To install the iOS RUM library using the Swift Package Manager (SPM) follow thes
 
 2. Select :guilabel:`Add Package` to install the package.
 
-.. note:: If you are also using CocoaPods, add the SPM package to the app's project, not to the Pods project in your workspace.
-
-CocoaPods
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
-
-To install the iOS RUM library using CocoaPods follow these steps:
-
-1. Make sure your project is using CocoaPods.
-
-2. Add ``pod 'SplunkOtel`` to your Podfile.
-
-3. Run ``pod install --repo-update`` in the directory where the Podfile is located.
-
-4. After installing the pod, make sure to open the .xcworkspace file instead of the .xcodeproj file.
-
 
 .. _rum-ios-initialize:
 

gdi/get-data-in/rum/ios/rum-ios-data-model.rst

@@ -163,7 +163,7 @@ By default, the iOS RUM library adds the following attributes to all spans:
      - Application name, as defined by :code:`using(Bundle.main.infoDictionary)`.
    * - ``splunk.rumSessionId``
      - String
-     - Session identifier, randomly generated by Splunk RUM. It doesn't contain personally identifiable information.
+     - Session identifier, randomly generated by Splunk RUM. It doesn't contain personally identifiable information. 
    * - ``splunk.rum.previous_session_id``
      - String
      - Identifier of the session preceding the current session. Set only if there is a change in the ``splunk.rumSessionId`` attribute.
@@ -421,6 +421,9 @@ App start monitoring produces spans with the name ``AppStart`` and the following
 Location data
 =============
 
+.. note:: 
+   The ``setLocation`` method is deprecated in Splunk RUM as of February 4, 2025. Although this method continues to function, it will be removed in a future version. There is no replacement for this annotation. 
+
 If you choose to set the latitude and longitude for location data by using the Splunk RUM for iOS APIs, Splunk Observability Cloud uses the information to map the geographical location of the user, such as country, city, and so on.
 
 .. list-table::

gdi/get-data-in/rum/react/manual-rum-react-instrumentation.rst

@@ -102,6 +102,10 @@ The following example shows how to report a custom error:
 Update location data
 ======================================
 
+.. note:: 
+   The ``updateLocation`` method is deprecated in Splunk RUM as of February 4, 2025. Although this method continues to function, it will be removed in a future version. There is no replacement for this annotation. 
+
+
 The RUM library includes a method for setting latitude ang longitde as global attributes. For example:
 
 .. code-block::

release-notes/2025-2-rn.rst

@@ -74,6 +74,16 @@ When Splunk removes support for a feature, platform, or browser it means that th
    * - Deprecated feature
      - Description
    * - Deprecation of Kubernetes classic Navigator interface
-     - As of January 30, 2025, Splunk Observability Cloud users can no longer access the Kubernetes classic Navigator interface. 
-
-       For more information, see :new-page:`https://community.splunk.com/t5/Product-News-Announcements/Deprecation-of-Splunk-Observability-Kubernetes-Classic-Navigator/ba-p/709016` in Splunk Community.
+     - As of February 4, 2025, Splunk Observability Cloud users can no longer access the Kubernetes classic Navigator interface. 
+
+       For more information, see :new-page:`https://community.splunk.com/t5/Product-News-Announcements/Deprecation-of-Splunk-Observability-Kubernetes-Classic-Navigator/ba-p/709016` in Splunk Community.
+   * - Deprecation of Android, iOS, and React instrumentation APIs  
+     - Certain APIs in the Android, iOS, and React instrumentation libraries have been deprecated or changed in Splunk RUM as of February 4, 2025. There are no breaking changes at this time, but support for deprecated APIs will be removed in a future release. 
+     
+       See the following topics for deprecation details.
+        * :ref:`configure-android-instrumentation`
+        * :ref:`android-rum-install`
+        * :ref:`manual-android-instrumentation`
+        * :ref:`configure-ios-instrumentation`
+        * :ref:`rum-ios-data`
+        * :ref:`manual-rum-react-instrumentation`