From 0834190bf62c5325b686acaca6675f86ec19dfd2 Mon Sep 17 00:00:00 2001 From: Fabrizio Ferri-Benedetti Date: Fri, 19 May 2023 13:12:41 +0200 Subject: [PATCH] Remove in-repo docs and edit links (#555) * Remove in-repo docs and edit links * Solve error * Update README.md Co-authored-by: Mateusz Rzeszutek * Update README.md --------- Co-authored-by: Mateusz Rzeszutek --- README.md | 35 +++++++++-------------------------- docs/faq.md | 28 ---------------------------- 2 files changed, 9 insertions(+), 54 deletions(-) delete mode 100644 docs/faq.md diff --git a/README.md b/README.md index d0e9c407a..da195cec0 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,8 @@ Getting Started   •   Getting Involved +   •   + Security

@@ -27,14 +29,6 @@

-

- - FAQ -   •   - Security - -

- --- # Splunk OpenTelemetry Instrumentation for Android @@ -54,33 +48,22 @@ For official documentation on the Splunk OTel Instrumentation for Android, see [ * Slow / frozen render detection * Offline buffering of telemetry via storage -## Troubleshooting - -- If you see runtime errors related to Java 8 interfaces and classes, make sure you have - enabled `coreLibraryDesugaring` per the official Android [documentation][desugar]. -- Report any bugs either here as a Github issue, or with official Splunk support channels. - ## Sample Application -This repository includes a sample application that can show off a few features of our mobile RUM -product. +This repository includes a sample application that demonstrates some features of the Android RUM agent. -In order to build and run the sample application, you will need to configure a `local.properties` -file in the root of the project. It will need to have two properties configured: +To build and run the sample application, configure a `local.properties` file in the root of the project. The project requires the following properties: ```properties rum.realm= rum.access.token= ``` -# License - -The Splunk Android RUM Instrumentation is licensed under the terms of the Apache Software License -version 2.0. See -[the license file](./LICENSE) for more details. +## Troubleshooting ->ℹ️  SignalFx was acquired by Splunk in October 2019. See [Splunk SignalFx](https://www.splunk.com/en_us/investor-relations/acquisitions/signalfx.html) for more information. +For troubleshooting issues with the Splunk OpenTelemetry instrumentation of Android, see [Troubleshoot Android instrumentation for Splunk Observability Cloud](https://quickdraw.splunk.com/redirect/?product=Observability&version=current&location=rum.android.troubleshooting) in the official documentation. -[desugar]: https://developer.android.com/studio/write/java8-support#library-desugaring +# License -[javadoc-url]: https://www.javadoc.io/doc/com.splunk/splunk-otel-android/latest/com/splunk/rum/SplunkRum.html +The Splunk Android RUM Instrumentation is licensed under the terms of the Apache Software License +version 2.0. See [the license file](./LICENSE) for more details. diff --git a/docs/faq.md b/docs/faq.md deleted file mode 100644 index def3c54bc..000000000 --- a/docs/faq.md +++ /dev/null @@ -1,28 +0,0 @@ - -## Frequently Asked Questions (FAQ) - -This document services as a central place for frequently asked -questions (FAQ) and common setup and troubleshooting advice. -Please [contribute](../CONTRIBUTING.md) to this list. - -### Why do I see "error handling gzip compressed request EOF" in Android Studio when I include Splunk RUM in my app? - -Splunk RUM uses gzip encoding to reduce network bandwidth consumption. Android Studio's -Network Inspector attempts to read the body of the http request and breaks the gzip -encoding; which results in 400 responses from our ingest servers. - -As a workaround, you can disable Splunk RUM while profiling your app, or you can disable -gzip compression at the time of profiling your app. - -This is a known issue with Android Studio's Network Inspector. -To learn more please review: https://issuetracker.google.com/issues/200699798 and https://issuetracker.google.com/issues/200852831 - -### How does this relate to OpenTelemetry - -We have started the process of donating the majority of this SDK to OpenTelemetry. -When we are finished, this project will be a lightweight customization of an upstream/official -OpenTelemetry Android Client SDK to support real user monitoring (RUM). - -You can following along with the OpenTelemetry client -[SIG notes](https://docs.google.com/document/d/16Vsdh-DM72AfMg_FIt9yT9ExEWF4A_vRbQ3jRNBe09w/edit#heading=h.yplevr950565) -or see `#otel-client-side-telemetry` in CNCF slack.