Add disk buffering config options to RUM conf (#275)

* Add disk buffering config options * Add changelog entry * Update CHANGELOG.md * Update specification/configuration.md * Update CHANGELOG.md --------- Co-authored-by: jason plumb <[email protected]> Co-authored-by: Robert Pająk <[email protected]>
signalfx · Oct 19, 2023 · e859629 · e859629
1 parent 94c6b64
commit e859629
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,8 @@
 - Require a CLA Assistant GitHub workflow. (#269)
 - Update the CLA notice in `CONTRIBUTING.md` template. (#269, #274)
 - Add Renovate as an acceptable alternative to Dependabot. (#271)
+- Add disk buffering configuration options for RUM mobile instrumentation
+  libraries. (#275)
 
 ## [1.6.0] - 2023-09-14
 

diff --git a/specification/configuration.md b/specification/configuration.md
@@ -266,14 +266,16 @@ etc.).
 RUM instrumentation libraries MUST support the following configuration
 properties:
 
-| Property (default value)   | Description                                                                                                                                                                                                |
-|----------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
-| `realm` ()                 | Splunk realm, e.g. `us0`, `us1`. If set, value of `beaconEndpoint` will be automatically computed based on this. [1] [2] [3]                                                                               |
-| `beaconEndpoint` ()        | RUM beacon URL, e.g. `https://rum-ingest.<realm>.signalfx.com/v1/rum`. If both `realm` and `beaconEndpoint` are set, `beaconEndpoint` takes precedence. [1] [2] [3]                                        |
-| `rumAccessToken` ()        | RUM authentication token. [1]                                                                                                                                                                              |
-| `applicationName` ()       | Instrumented application name. [1]                                                                                                                                                                         |
-| `globalAttributes` ()      | OpenTelemetry [Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute) that will be added to every span produced by the RUM library. |
-| `deploymentEnvironment` () | Sets the environment (`deployment.environment` span attribute) for all spans.                                                                                                                              |
+| Property (default value)       | Description                                                                                                                                                                                                |
+|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| `realm` ()                     | Splunk realm, e.g. `us0`, `us1`. If set, value of `beaconEndpoint` will be automatically computed based on this. [1] [2] [3]                                                                               |
+| `beaconEndpoint` ()            | RUM beacon URL, e.g. `https://rum-ingest.<realm>.signalfx.com/v1/rum`. If both `realm` and `beaconEndpoint` are set, `beaconEndpoint` takes precedence. [1] [2] [3]                                        |
+| `rumAccessToken` ()            | RUM authentication token. [1]                                                                                                                                                                              |
+| `applicationName` ()           | Instrumented application name. [1]                                                                                                                                                                         |
+| `globalAttributes` ()          | OpenTelemetry [Attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/main/specification/common/README.md#attribute) that will be added to every span produced by the RUM library. |
+| `deploymentEnvironment` ()     | Sets the environment (`deployment.environment` span attribute) for all spans.                                                                                                                              |
+| `enableDiskBuffering` (false)  | **Mobile only.** Enables the storage-based buffering of telemetry.                                                                                                                                         |
+| `limitDiskUsageMegabytes` (25) | **Mobile only.** Sets the limit of the max number of megabytes that will be used to buffer telemetry data in storage.                                                                                      |
 
 - [1] Application name, authentication token and either realm or the beacon URL
   MUST be provided by the user. If any of these is missing, the RUM