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

Commit b27e540

Browse files
Merge pull request #1672 from splunk/repo-sync
Pulling refs/heads/main into main
2 parents bafa785 + 5d114b9 commit b27e540

File tree

14 files changed

+49
-34
lines changed

14 files changed

+49
-34
lines changed

_includes/requirements/android.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +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`.
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`. Android 7.0 (also known as Nougat) corresponds to API level 24.

_includes/requirements/ios.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
Splunk RUM for Mobile supports the following versions:
22

3-
* iOS 11 and higher
3+
* iOS 15 and higher
44
* iPadOS 13 and higher
55

66
Splunk RUM supports Apple Silicon.

gdi/get-data-in/application/python/configuration/python-otel-metrics.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ To learn about the different metric types, see :ref:`metric-types`.
1313

1414
For examples of custom metrics instrumentation and instrument types, see :ref:`custom-metrics-python`.
1515

16-
.. caution:: This feature is experimental, and exported metric data and configuration properties might change. To learn more, see :new-page:`https://github.com/signalfx/splunk-otel-python/blob/main/docs/advanced-config.md`.
16+
.. caution:: This feature is experimental, and exported metric data and configuration properties might change. To learn more, see :new-page:`https://github.com/signalfx/splunk-otel-python/blob/main/README.md`.
1717

1818
.. _python-app-metrics:
1919

gdi/get-data-in/application/python/splunk-python-otel-distribution.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ Support for previous versions
3838

3939
Splunk is committed to supporting all customers who use this distribution. All major versions of Splunk OpenTelemetry distributions receive critical patches for one year after the next major release. Splunk stops feature development on a major release after it introduces the next major release.
4040

41-
For more information on versioning of the Splunk Distribution of OpenTelemetry Python, see :new-page:`the release guidelines <https://github.com/signalfx/splunk-otel-python/blob/main/RELEASING.md>` on GitHub.
41+
For more information on versioning of the Splunk Distribution of OpenTelemetry Python, see :new-page:`the release guidelines <https://github.com/signalfx/splunk-otel-python/blob/main/CHANGELOG.md>` on GitHub.
4242

4343
How to contribute
4444
=========================================================

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

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ Use the following settings to configure the Android RUM agent:
6565
* - :code:`enableDebug()`
6666
- 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.
6767
* - :code:`enableExperimentalOtlpExporter()`
68-
- Activates the experimental OTLP exporter. The exporter is not compatible with disk buffering.
68+
- 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.
6969

7070
.. _android-rum-instrumentation-settings:
7171

@@ -105,6 +105,9 @@ The Android RUM agent includes instrumentation for the OkHttp and Volley HTTP cl
105105
OkHttp
106106
-----------------------------------------------
107107

108+
.. note::
109+
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.
110+
108111
Instrument OkHttp using the ``Call.Factory`` wrapper, as in the following example:
109112

110113
.. code-block:: java
@@ -116,6 +119,9 @@ Instrument OkHttp using the ``Call.Factory`` wrapper, as in the following exampl
116119
Volley HTTP (Experimental)
117120
-------------------------------------------------
118121

122+
.. note::
123+
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.
124+
119125
To instrument Volley HTTP, add the ``splunk-otel-android-volley`` dependency to the ``build.gradle.kts`` file:
120126

121127
.. code-block:: java

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

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ To instrument your Android application and get data into Splunk RUM, follow the
2020
Decide which version to run in your environment
2121
=======================================================
2222

23-
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.
23+
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.
2424

2525

2626
Check compatibility and requirements
@@ -194,6 +194,10 @@ Follow these steps to install the Android RUM agent using Maven Central:
194194
195195
See :ref:`android-rum-http-client-settings` for more information.
196196

197+
.. note::
198+
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.
199+
200+
197201
5. Release the changes to the Android application.
198202

199203
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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -143,6 +143,9 @@ The following example shows how to start a workflow for which metrics are record
143143
Customize screen names
144144
=====================================
145145

146+
.. note::
147+
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.
148+
146149
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.
147150

148151
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

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,6 @@ The following example shows how to configure the RUM token, realm, environment n
2121
//..
2222
SplunkRumBuilder(realm: "<realm>", rumAuth: "<rum-token>")
2323
// Call functions to configure additional options
24-
.allowInsecureBeacon(enabled: true)
2524
.debug(enabled: true)
2625
.globalAttributes(globalAttributes: ["strKey": "strVal", "intKey": 7, "doubleKey": 1.5, "boolKey": true])
2726
.deploymentEnvironment(environment: "env")
@@ -37,7 +36,6 @@ The following example shows how to configure the RUM token, realm, environment n
3736
//...
3837

3938
SplunkRumBuilder *builder = [[SplunkRumBuilder alloc] initWithBeaconUrl:@"https://rum-ingest.<realm>.signalfx.com/v1/rum" rumAuth: @"<rum-token>"]];
40-
[builder allowInsecureBeaconWithEnabled:true];
4139
[builder globalAttributesWithGlobalAttributes:[NSDictionary dictionary]];
4240
[builder debugWithEnabled:true];
4341
[builder deploymentEnvironmentWithEnvironment:@"environment-name"];
@@ -94,13 +92,13 @@ Use the following settings to configure the behavior of iOS RUM instrumentation:
9492
* - :code:`sessionSamplingRatio`
9593
- Percentage of sessions to sample. Expressed as a proportion in the range ``0.0`` to ``1.0``. The default value is ``1.0``.
9694
* - :code:`allowInsecureBeacon`
97-
- If set to ``true``, this setting allows beacon URLs that use the HTTP protocol. The default value is ``false``.
95+
- 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.
9896
* - :code:`enableDiskCache`
99-
- Activates caching of exported spans. All spans are written to local storage and deleted after a successful export. The default value is ``false``.
97+
- 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.
10098
* - :code:`spanDiskCacheMaxSize`
101-
- 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.
99+
- 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.
102100
* - :code:`bspScheduleDelay`
103-
- Sets the maximum interval between two consecutive span exports. The default value is 5 seconds.
101+
- 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.
104102
* - :code:`slowRenderingDetectionEnabled`
105103
- Activates the slow rendering detection feature. The default value is ``true``. See :ref:`ios-slow-rendering-data`.
106104
* - :code:`slowFrameDetectionThresholdMs`

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

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -91,21 +91,6 @@ To install the iOS RUM library using the Swift Package Manager (SPM) follow thes
9191

9292
2. Select :guilabel:`Add Package` to install the package.
9393

94-
.. note:: If you are also using CocoaPods, add the SPM package to the app's project, not to the Pods project in your workspace.
95-
96-
CocoaPods
97-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98-
99-
To install the iOS RUM library using CocoaPods follow these steps:
100-
101-
1. Make sure your project is using CocoaPods.
102-
103-
2. Add ``pod 'SplunkOtel`` to your Podfile.
104-
105-
3. Run ``pod install --repo-update`` in the directory where the Podfile is located.
106-
107-
4. After installing the pod, make sure to open the .xcworkspace file instead of the .xcodeproj file.
108-
10994

11095
.. _rum-ios-initialize:
11196

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ By default, the iOS RUM library adds the following attributes to all spans:
163163
- Application name, as defined by :code:`using(Bundle.main.infoDictionary)`.
164164
* - ``splunk.rumSessionId``
165165
- String
166-
- Session identifier, randomly generated by Splunk RUM. It doesn't contain personally identifiable information.
166+
- Session identifier, randomly generated by Splunk RUM. It doesn't contain personally identifiable information.
167167
* - ``splunk.rum.previous_session_id``
168168
- String
169169
- 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
421421
Location data
422422
=============
423423

424+
.. note::
425+
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.
426+
424427
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.
425428

426429
.. list-table::

0 commit comments

Comments
 (0)