Skip to content

Commit e702886

Browse files
breedx-splkbreedx-splk
authored
Remove real user monitoring / rum (#344)
* remove real user monitoring / rum # Conflicts: # specification/repository.md * remove rum repos from list
1 parent 8ad50d1 commit e702886

File tree

5 files changed

+0
-108
lines changed

5 files changed

+0
-108
lines changed

‎.github/ISSUE_TEMPLATE/ga_request.md

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -51,11 +51,6 @@ Name and link to repository
5151
- [ ] Documents how to configure manual instrumentation.
5252
- [ ] Documents how to configure log correlation.
5353
- [ ] Documents minimum supported version of each auto-instrumentation framework.
54-
- [ ] [Real User Monitoring Library](https://github.com/signalfx/gdi-specification/blob/v1.6.0/specification/repository.md#real-user-monitoring-libraries)
55-
- [ ] Documents all supported configuration parameters.
56-
- [ ] Documents how to configure manual instrumentation.
57-
- [ ] Documents supported instrumentation.
58-
- [ ] Documents supported platforms.
5954

6055
### How long has the GDI repository been public?
6156

‎repositories.txt

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,12 @@
1-
https://github.com/signalfx/splunk-otel-android
21
https://github.com/signalfx/splunk-otel-collector
32
https://github.com/signalfx/splunk-otel-collector-operator
43
https://github.com/signalfx/splunk-otel-collector-chart
54
https://github.com/signalfx/splunk-otel-collector-heroku
65
https://github.com/signalfx/splunk-otel-cpp
76
https://github.com/signalfx/splunk-otel-dotnet
87
https://github.com/signalfx/splunk-otel-go
9-
https://github.com/signalfx/splunk-otel-ios
10-
https://github.com/signalfx/splunk-otel-ios-crashreporting
118
https://github.com/signalfx/splunk-otel-java
129
https://github.com/signalfx/splunk-otel-js
13-
https://github.com/signalfx/splunk-otel-js-web
1410
https://github.com/signalfx/splunk-otel-lambda
1511
https://github.com/signalfx/splunk-otel-python
1612
https://github.com/signalfx/splunk-otel-react-native

‎specification/configuration.md

Lines changed: 0 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -257,48 +257,6 @@ In addition to environment variables, other ways of defining configuration also
257257
system property `splunk.trace-response-header.enabled` is equivalent to environment
258258
variable `SPLUNK_TRACE_RESPONSE_HEADER_ENABLED`.
259259
260-
### Real User Monitoring Libraries
261-
262-
**Status**: [Stable](../README.md#versioning-and-status-of-the-specification)
263-
264-
Real User Monitoring (RUM) instrumentation libraries cannot use environment
265-
variables for configuration. Instead, they MUST expose a `SplunkRum`
266-
object/class/namespace (depending on the language used) that allows setting the
267-
properties listed below (in a language-specific way: Java may use builders,
268-
Swift can use named parameters with default values, JavaScript can use objects,
269-
etc.).
270-
271-
RUM instrumentation libraries MUST support the following configuration
272-
properties:
273-
274-
| Property (default value) | Description |
275-
|--------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
276-
| `realm` () | Splunk realm, e.g. `us0`, `us1`. If set, value of `beaconEndpoint` will be automatically computed based on this. [1] [2] [3] |
277-
| `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] |
278-
| `rumAccessToken` () | RUM authentication token. [1] |
279-
| `applicationName` () | Instrumented application name. [1] |
280-
| `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. |
281-
| `deploymentEnvironment` () | Sets the environment (`deployment.environment` span attribute) for all spans. |
282-
| `enableDiskBuffering` (false) | **Mobile only.** Enables the storage-based buffering of telemetry. |
283-
| `limitDiskUsageMegabytes` (25) | **Mobile only.** Sets the limit of the max number of megabytes that will be used to buffer telemetry data in storage. |
284-
285-
- [1] Application name, authentication token and either realm or the beacon URL
286-
MUST be provided by the user. If any of these is missing, the RUM
287-
instrumentation library MUST fail to start.
288-
- [2] Systems that allow implementations to enforce the `beaconEndpoint` value
289-
is https (i.e. not Android) MUST do so. These implementations need to
290-
reject/fail to start if this condition is not meet. Implementations MAY offer
291-
an unrecommended `allowInsecureBeacon` option (default false) that turns off
292-
the check.
293-
- [3] If both `realm` and `beaconEndpoint` are set, a warning saying that
294-
`realm` will be ignored SHOULD be logged.
295-
296-
Other requirements:
297-
298-
- RUM library MUST use the Zipkin v2 JSON span exporter by default
299-
- RUM library MUST limit the number of sent spans to 100 in a 30 second window
300-
per `component` attribute value
301-
302260
### Serverless
303261
304262
**Status**: [Experimental](../README.md#versioning-and-status-of-the-specification)

‎specification/repository.md

Lines changed: 0 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -206,14 +206,3 @@ are a good example of this.
206206
the `deployments` folder at the repository root.
207207
- An historical exemption is provided for `splunk-otel-collector-chart`, which
208208
MAY live in a separate repository.
209-
210-
## Real User Monitoring Libraries
211-
212-
- MUST document all configuration parameters that are relevant
213-
to Splunk Observability Cloud
214-
- MUST document all configuration parameters whose default or accepted values
215-
deviate from upstream
216-
- MUST document how to configure manual instrumentation
217-
- MUST document supported instrumentations
218-
- MUST document supported platforms: browsers, OS versions, API requirements
219-
- MAY host the documentation in the [Observability Cloud documentation repository](https://github.com/splunk/public-o11y-docs)

‎specification/semantic_conventions.md

Lines changed: 0 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,6 @@ All Splunk distributions of OpenTelemetry,
2929

3030
- SHOULD set [process and process runtime resource attributes](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.18.0/specification/resource/semantic_conventions/process.md)
3131

32-
Note: this section does not apply to Real User Monitoring libraries, as they do
33-
not use the OpenTelemetry Resource.
34-
3532
## Splunk Resource Attributes
3633

3734
**Status**: [Deprecated](../README.md#versioning-and-status-of-the-specification)
@@ -43,9 +40,6 @@ version in combination with OpenTelemetry's `telemetry.sdk.*` attributes.
4340
|---|---|---|---|---|
4441
| `splunk.distro.version` | string | The version number of the Splunk distribution being used. | `1.5.0` | Yes |
4542

46-
Note: this section does not apply to Real User Monitoring libraries, as they do
47-
not use the OpenTelemetry Resource.
48-
4943
## Runtime Environment Metrics
5044

5145
**Status**: [Experimental](../README.md#versioning-and-status-of-the-specification)
@@ -55,46 +49,6 @@ SHOULD collect
5549
[Runtime Environment Metrics](https://github.com/open-telemetry/opentelemetry-specification/blob/v1.18.0/specification/metrics/semantic_conventions/runtime-environment-metrics.md)
5650
when metrics are enabled.
5751

58-
## Real User Monitoring Spans and Attributes
59-
60-
**Status**: [Experimental](../README.md#versioning-and-status-of-the-specification)
61-
62-
Real User Monitoring (RUM) libraries MUST set the `service.name` resource
63-
attribute to the value of the `applicationName` configuration property. This is
64-
the only resource attribute that RUM libraries are supposed to set because it's
65-
the only one the Zipkin exporter can understand.
66-
67-
The following attributes MUST be added to all spans produced by RUM libraries:
68-
69-
| Name | Type | Description |
70-
| ---- | ---- | ----------- |
71-
| `app` | string | The value of the `applicationName` property configured in `SplunkRum`; same as `service.name` resource attribute. |
72-
| `splunk.rumSessionId` | string | The RUM session ID |
73-
| `splunk.rum.version` | string | Version of the RUM library |
74-
| `component` | string | Name of the instrumentation that produced this span |
75-
76-
The following attributes MAY be added to all spans emitted by RUM libraries:
77-
78-
| Name | Type | Description |
79-
| ---- | ---- | ----------- |
80-
| `deployment.environment` | string | Value of the `deploymentEnvironment` property configured in `SplunkRum`, if any |
81-
82-
Mobile RUM libraries (iOS, Android) MUST add device and system information to
83-
all spans:
84-
85-
| Name | Type | Description |
86-
| ---- | ---- | ----------- |
87-
| `device.model.name` | string | Name of the device |
88-
| `os.name` | string | `iOS` or `Android` |
89-
| `os.version` | string | Version of the OS |
90-
91-
Web RUM library MUST add the following attributes to all spans:
92-
93-
| Name | Type | Description |
94-
| ---- | ---- | ----------- |
95-
| `location.href` | string | Value of [`location.href`](https://developer.mozilla.org/en-US/docs/Web/API/Location/href) at the moment of creating the span. |
96-
| `splunk.script_instance` | string | A 64bit identifier, unique to every instance of the `SplunkRum` library. |
97-
9852
## Profiling `ResourceLogs` Message
9953

10054
**Status**: [Experimental](../README.md#versioning-and-status-of-the-specification)

0 commit comments

Comments
 (0)