diff --git a/CHANGELOG.md b/CHANGELOG.md index 394c1a469..1f09b8dbc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,20 @@ adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). * TBD +## Version 1.0.0-rc.2 + +Release candidate for 1.0.0. + +* Updated to OpenTelemetry Java v1.19.0 (#383) +* Fixed a bug where sometimes crash reports were not exported (#368) +* Added runtime details (storage, memory, battery) to crash reports (#369) +* Removed deprecated classes (#372) +* Included activity name in slow and frozen render reports (#373) +* Renamed the `SplunkRumBuilder#disableNetworkMonitorEnabled()` method to + `SplunkRumBuilder#disableNetworkMonitor()` (#377) +* Added experimental React Native support (React Native lib will be developed and released + separately) (#381) + ## Version 1.0.0-rc.1 Release candidate for 1.0.0. diff --git a/README.md b/README.md index 5711b508b..38092f035 100644 --- a/README.md +++ b/README.md @@ -9,8 +9,8 @@
-
-
+
+
@@ -91,7 +91,7 @@ Then, add the latest release as a dependency in your application's build.gradle
```
dependencies {
...
- implementation ("com.splunk:splunk-otel-android:1.0.0-rc.1")
+ implementation ("com.splunk:splunk-otel-android:1.0.0-rc.2")
...
}
```
@@ -127,7 +127,7 @@ Then, add the locally built library as a dependency in your application's build.
```
dependencies {
...
- implementation ("com.splunk:splunk-otel-android:1.0.0-rc.2-SNAPSHOT")
+ implementation ("com.splunk:splunk-otel-android:1.0.0-rc.3-SNAPSHOT")
...
}
```
diff --git a/splunk-otel-android-volley/README.md b/splunk-otel-android-volley/README.md
index d367cab77..3001ff3cf 100644
--- a/splunk-otel-android-volley/README.md
+++ b/splunk-otel-android-volley/README.md
@@ -16,7 +16,7 @@ you will also need to add the `splunk-otel-android-volley` dependency to your `b
```gradle
dependencies {
...
- implementation("com.splunk:splunk-otel-android-volley:1.0.0-rc.1")
+ implementation("com.splunk:splunk-otel-android-volley:1.0.0-rc.2")
...
}
```
diff --git a/splunk-otel-android/src/main/java/com/splunk/rum/SplunkRumBuilder.java b/splunk-otel-android/src/main/java/com/splunk/rum/SplunkRumBuilder.java
index 83c172d80..d7cae4bb1 100644
--- a/splunk-otel-android/src/main/java/com/splunk/rum/SplunkRumBuilder.java
+++ b/splunk-otel-android/src/main/java/com/splunk/rum/SplunkRumBuilder.java
@@ -85,7 +85,7 @@ public SplunkRumBuilder setBeaconEndpoint(String beaconEndpoint) {
* Sets the realm for the beacon to send RUM telemetry to. This should be used in place of the
* {@link #setBeaconEndpoint(String)} method in most cases.
*
- * @param realm A valid Splunk "realm"
+ * @param realm A valid Splunk "realm", e.g. "us0", "eu0".
* @return {@code this}
*/
public SplunkRumBuilder setRealm(String realm) {
@@ -113,8 +113,7 @@ public SplunkRumBuilder setRumAccessToken(String rumAuthToken) {
/**
* Enables debugging information to be emitted from the RUM library.
*
- * This feature is disabled by default. You can enable it by calling this configuration
- * method with a {@code true} value.
+ * This feature is disabled by default. You can enable it by calling this method.
*
* @return {@code this}
*/
@@ -128,8 +127,7 @@ public SplunkRumBuilder enableDebug() {
* buffered in the local storage until it is exported; otherwise, it is buffered in memory and
* throttled.
*
- * This feature is disabled by default. You can enable it by calling this configuration
- * method with a {@code true} value.
+ * This feature is disabled by default. You can enable it by calling this method.
*
* @return {@code this}
*/
@@ -153,8 +151,7 @@ public SplunkRumBuilder enableReactNativeSupport() {
/**
* Disables the crash reporting feature.
*
- * This feature is enabled by default. You can disable it by calling this configuration
- * method with a {@code true} value.
+ * This feature is enabled by default. You can disable it by calling this method.
*
* @return {@code this}
*/
@@ -166,8 +163,7 @@ public SplunkRumBuilder disableCrashReporting() {
/**
* Disables the network monitoring feature.
*
- * This feature is enabled by default. You can disable it by calling this configuration
- * method with a {@code true} value.
+ * This feature is enabled by default. You can disable it by calling this method.
*
* @return {@code this}
*/
@@ -181,8 +177,7 @@ public SplunkRumBuilder disableNetworkMonitor() {
* thread is unresponsive for 5 seconds or more, an event including the main thread's stack
* trace will be reported to the RUM system.
*
- * This feature is enabled by default. You can disable it by calling this configuration
- * method with a {@code true} value.
+ * This feature is enabled by default. You can disable it by calling this method.
*
* @return {@code this}
*/
@@ -194,8 +189,7 @@ public SplunkRumBuilder disableAnrDetection() {
/**
* Disables the slow rendering detection feature.
*
- * This feature is enabled by default. You can disable it by calling this configuration
- * method with a {@code true} value.
+ * This feature is enabled by default. You can disable it by calling this method.
*
* @return {@code this}
*/
@@ -207,7 +201,7 @@ public SplunkRumBuilder disableSlowRenderingDetection() {
/**
* Configures the rate at which frame render durations are polled.
*
- * @param interval The period that should be used for polling
+ * @param interval The period that should be used for polling.
* @return {@code this}
*/
public SplunkRumBuilder setSlowRenderingDetectionPollInterval(Duration interval) {
@@ -247,7 +241,7 @@ public SplunkRumBuilder setDeploymentEnvironment(String environment) {
/**
* Configures span data filtering.
*
- * @param configurer A function that will configure the passed {@link SpanFilterBuilder}
+ * @param configurer A function that will configure the passed {@link SpanFilterBuilder}.
* @return {@code this}
*/
public SplunkRumBuilder filterSpans(Consumer This setting only applies when {@linkplain #enableDiskBuffering() disk buffering is
+ * enabled}.
+ *
+ * @param maxUsageMegabytes The maximum disk buffer size, in megabytes.
* @return {@code this}
*/
public SplunkRumBuilder limitDiskUsageMegabytes(int maxUsageMegabytes) {
@@ -274,6 +272,7 @@ public SplunkRumBuilder limitDiskUsageMegabytes(int maxUsageMegabytes) {
* This feature is disabled by default - i.e. by default, all sessions are sampled, which is
* equivalent to {@code ratio = 1.0}.
*
+ * @param ratio The desired ratio of sampling. Must be within [0.0, 1.0].
* @return {@code this}
*/
public SplunkRumBuilder enableSessionBasedSampling(double ratio) {