From 40199e57f50db4b3b5703c8c84036727fe5d2010 Mon Sep 17 00:00:00 2001 From: mhennoch Date: Wed, 18 Oct 2023 17:03:23 +0300 Subject: [PATCH 1/5] Add disk buffering config options --- specification/configuration.md | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/specification/configuration.md b/specification/configuration.md index 7881604..77e0c3a 100644 --- 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..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..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 From 481bc5729ee70d00d9175c642a4393bf3d80e4a5 Mon Sep 17 00:00:00 2001 From: mhennoch Date: Wed, 18 Oct 2023 20:35:49 +0300 Subject: [PATCH 2/5] Add changelog entry --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index e150cc3..70b7b49 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ - Require a CLA Assistant GitHub workflow. (#269) - Update the CLA notice in `CONTRIBUTING.md` template. (#269) - Add Renovate as an acceptable alternative to Dependabot. (#271) +- Add disk buffering configuration options for RUM (#275) ## [1.6.0] - 2023-09-14 From 3e3b4f9b2b669cb25230a187a133246e4d82a891 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 19 Oct 2023 08:59:08 +0200 Subject: [PATCH 3/5] Update CHANGELOG.md --- CHANGELOG.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index c22e57d..5a47ac9 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +9,7 @@ - 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 (#275) +- Add disk buffering configuration options for RUM mobile instrumentation libraries. (#275) ## [1.6.0] - 2023-09-14 From 6bf8c3feb3d511d67701d031b91c29819bc5db6e Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 19 Oct 2023 09:00:16 +0200 Subject: [PATCH 4/5] Update specification/configuration.md --- specification/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/configuration.md b/specification/configuration.md index 77e0c3a..21f311e 100644 --- a/specification/configuration.md +++ b/specification/configuration.md @@ -274,7 +274,7 @@ properties: | `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 | +| `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 From 5c4ae4ad7b4c3a0e5a5319c11c18293b55d88363 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Robert=20Paj=C4=85k?= Date: Thu, 19 Oct 2023 09:01:13 +0200 Subject: [PATCH 5/5] Update CHANGELOG.md --- CHANGELOG.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 5a47ac9..f8215e3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,7 +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) +- Add disk buffering configuration options for RUM mobile instrumentation + libraries. (#275) ## [1.6.0] - 2023-09-14