Instrumentation installation instructions (#1068)

* Adding crash installation instructions

* Adding activity installation instructions

* Adding anr installation instructions

* Adding fragment installation instructions

* Adding network installation instructions

* Adding slowrendering installation instructions

* Adding startup installation instructions

* Adding android-log installation instructions

* Adding compose-click installation instructions

* Adding okhttp3-websocket installation instructions

* Adding sessions installation instructions

* Adding view-click installation instructions

Author: LikeTheSalad

android-agent/build.gradle.kts

@@ -24,6 +24,7 @@ dependencies {
     api(project(":instrumentation:network"))
     api(project(":instrumentation:slowrendering"))
     api(project(":instrumentation:startup"))
+    api(project(":instrumentation:sessions"))
 
     testImplementation(libs.robolectric)
 }

instrumentation/activity/README.md

@@ -37,3 +37,18 @@ This instrumentation produces the following telemetry:
   * `activity.name`:  name of activity
   * `screen.name`:  name of screen
   * `last.screen.name`:  name of screen, only when span contains the `activityPostResumed` event.
+
+## Installation
+
+This instrumentation comes with the [android agent](../../android-agent) out of the box, so
+if you depend on it, you don't need to do anything else to install this instrumentation.
+However, if you don't use the agent but instead depend on [core](../../core) directly, you can
+manually install this instrumentation by following the steps below.
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:activity:LATEST_VERSION") // <1>
+```
+
+1. You can find the latest version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/activity).

instrumentation/android-log/README.md

@@ -18,3 +18,28 @@ This instrumentation produces the following telemetry:
     * `android.log.tag`: The tag passed to `android.uti.Log.x`
     * `exception.stacktrace` - Optional. See the ([semconv here](https://github.com/open-telemetry/semantic-conventions/blob/727700406f9e6cc3f4e4680a81c4c28f2eb71569/docs/attributes-registry/exception.md#exception-stacktrace)).
     * `exception.type` - Optional. See the ([semconv here](https://github.com/open-telemetry/semantic-conventions/blob/727700406f9e6cc3f4e4680a81c4c28f2eb71569/docs/attributes-registry/exception.md#exception-type))
+
+## Installation
+
+### Applying the Byte Buddy plugin
+
+This instrumentation makes use of [Byte Buddy](https://bytebuddy.net/) to do bytecode instrumentation. Because of this, you need
+to ensure that your application has the Byte Buddy plugin applied, as shown below.
+
+```kotlin
+plugins {
+  id("net.bytebuddy.byte-buddy-gradle-plugin") version "LATEST_VERSION" // <1>
+}
+```
+
+1. You can find the latest version [here](https://plugins.gradle.org/plugin/net.bytebuddy.byte-buddy-gradle-plugin).
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:android-log-library:LATEST_LIBRARY_VERSION") // <1>
+byteBuddy("io.opentelemetry.android.instrumentation:android-log-agent:LATEST_AGENT_VERSION") // <2>
+```
+
+1. You can find the latest library version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/android-log-library).
+2. You can find the latest instrumentation agent version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/android-log-agent).

instrumentation/anr/README.md

@@ -28,3 +28,18 @@ This instrumentation produces the following telemetry:
 
 Note: This instrumentation supports additional user-configurable `AttributeExtractors` that
 may set additional attributes from the given `StackTraceElement[]`.
+
+## Installation
+
+This instrumentation comes with the [android agent](../../android-agent) out of the box, so
+if you depend on it, you don't need to do anything else to install this instrumentation.
+However, if you don't use the agent but instead depend on [core](../../core) directly, you can
+manually install this instrumentation by following the steps below.
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:anr:LATEST_VERSION") // <1>
+```
+
+1. You can find the latest version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/anr).

instrumentation/compose/click/README.md

@@ -34,3 +34,13 @@ This instrumentation produces the following telemetry:
 * Description: This event is emitted when the user taps on a composable that is clickable.
 * See the [semantic convention definition](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/app/app.md#event-appwidgetclick)
   for more details.
+
+## Installation
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:compose-click:LATEST_VERSION") // <1>
+```
+
+1. You can find the latest version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/compose-click).

instrumentation/crash/README.md

@@ -24,3 +24,18 @@ This instrumentation produces the following telemetry:
 
 Note: This instrumentation supports additional user-configurable `AttributeExtractors` that
 may set additional attributes from the given `CrashDetails` (`Thread` and `Throwable`).
+
+## Installation
+
+This instrumentation comes with the [android agent](../../android-agent) out of the box, so
+if you depend on it, you don't need to do anything else to install this instrumentation.
+However, if you don't use the agent but instead depend on [core](../../core) directly, you can
+manually install this instrumentation by following the steps below.
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:crash:LATEST_VERSION") // <1>
+```
+
+1. You can find the latest version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/crash).

instrumentation/fragment/README.md

@@ -22,3 +22,18 @@ This instrumentation produces the following telemetry:
     * `fragment.name`:  name of fragment
     * `screen.name`:  name of screen
     * `last.screen.name`:  name of screen, when span contains the `fragmentResumed` event.
+
+## Installation
+
+This instrumentation comes with the [android agent](../../android-agent) out of the box, so
+if you depend on it, you don't need to do anything else to install this instrumentation.
+However, if you don't use the agent but instead depend on [core](../../core) directly, you can
+manually install this instrumentation by following the steps below.
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:fragment:LATEST_VERSION") // <1>
+```
+
+1. You can find the latest version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/fragment).

instrumentation/network/README.md

@@ -27,3 +27,18 @@ This instrumentation produces the following telemetry:
 
 Note: This instrumentation supports additional user-configurable `AttributeExtractors` that
 may set additional attributes when given a `CurrentNetwork` instance.
+
+## Installation
+
+This instrumentation comes with the [android agent](../../android-agent) out of the box, so
+if you depend on it, you don't need to do anything else to install this instrumentation.
+However, if you don't use the agent but instead depend on [core](../../core) directly, you can
+manually install this instrumentation by following the steps below.
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:network:LATEST_VERSION") // <1>
+```
+
+1. You can find the latest version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/network).

instrumentation/okhttp3-websocket/README.md

@@ -0,0 +1,30 @@
+# Android Instrumentation for OkHttp Websocket version 3.0 and higher
+
+## Status: development
+
+Provides OpenTelemetry instrumentation for [okhttp3 websockets](https://square.github.io/okhttp/3.x/okhttp/okhttp3/WebSocket.html).
+
+## Installation
+
+### Applying the Byte Buddy plugin
+
+This instrumentation makes use of [Byte Buddy](https://bytebuddy.net/) to do bytecode instrumentation. Because of this, you need
+to ensure that your application has the Byte Buddy plugin applied, as shown below.
+
+```kotlin
+plugins {
+  id("net.bytebuddy.byte-buddy-gradle-plugin") version "LATEST_VERSION" // <1>
+}
+```
+
+1. You can find the latest version [here](https://plugins.gradle.org/plugin/net.bytebuddy.byte-buddy-gradle-plugin).
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:okhttp3-websocket-library:LATEST_LIBRARY_VERSION") // <1>
+byteBuddy("io.opentelemetry.android.instrumentation:okhttp3-websocket-agent:LATEST_AGENT_VERSION") // <2>
+```
+
+1. You can find the latest library version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/okhttp3-websocket-library).
+2. You can find the latest instrumentation agent version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/okhttp3-websocket-agent).

instrumentation/sessions/README.md

@@ -11,3 +11,18 @@ for additional details about sessions.
 
 See ["Session Events"](https://github.com/open-telemetry/semantic-conventions/blob/main/docs/general/session.md#session-events)
 for more information about the specific events generated by this instrumentation.
+
+## Installation
+
+This instrumentation comes with the [android agent](../../android-agent) out of the box, so
+if you depend on it, you don't need to do anything else to install this instrumentation.
+However, if you don't use the agent but instead depend on [core](../../core) directly, you can
+manually install this instrumentation by following the steps below.
+
+### Adding dependencies
+
+```kotlin
+implementation("io.opentelemetry.android.instrumentation:sessions:LATEST_VERSION") // <1>
+```
+
+1. You can find the latest version [here](https://central.sonatype.com/artifact/io.opentelemetry.android.instrumentation/sessions).