Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add disk buffering config options to RUM conf #275

Merged
merged 7 commits into from
Oct 19, 2023
Merged

Add disk buffering config options to RUM conf #275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
40199e5
Add disk buffering config options
mhennoch Oct 18, 2023
4ca588d
Merge branch 'main' into rum-disk-buffer
mhennoch Oct 18, 2023
481bc57
Add changelog entry
mhennoch Oct 18, 2023
bbe11ab
Merge branch 'main' into rum-disk-buffer
breedx-splk Oct 18, 2023
3e3b4f9
Update CHANGELOG.md
pellared Oct 19, 2023
6bf8c3f
Update specification/configuration.md
pellared Oct 19, 2023
5c4ae4a
Update CHANGELOG.md
pellared Oct 19, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
18 changes: 10 additions & 8 deletions specification/configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down