Skip to content

Commit f646b89

Browse files
committed
Update README structure and content
1 parent 3907a4e commit f646b89

File tree

1 file changed

+34
-45
lines changed

1 file changed

+34
-45
lines changed

README.md

Lines changed: 34 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,15 @@
55
[![OpenSSF Scorecard](https://api.scorecard.dev/projects/github.com/open-telemetry/opentelemetry-android/badge)](https://scorecard.dev/viewer/?uri=github.com/open-telemetry/opentelemetry-android)
66
[![android api](https://img.shields.io/badge/Android_API-21-green.svg "Android min API 21")](VERSIONING.md)
77

8-
## Status: development
9-
108
* [About](#about)
119
* [Getting Started](#getting-started)
12-
* [Features](#contributing)
10+
* [Features](#features)
1311
* [Contributing](#contributing)
14-
* [StrictMode Policy](./docs/STRICTMODE.md)
15-
* [Exporter Chain](./docs/EXPORTER_CHAIN.md)
1612

1713
# About
1814

19-
The repository contains the OpenTelemetry Android SDK for generating mobile
20-
client telemetry for real user monitoring (RUM). It is built on top
21-
of the [OpenTelemetry Java SDK](https://github.com/open-telemetry/opentelemetry-java).
15+
The repository contains the `OpenTelemetry Android Agent`, which initializes the [OpenTelemetry Java SDK](https://github.com/open-telemetry/opentelemetry-java) and provides
16+
auto-instrumentation of Android apps for real user monitoring (RUM).
2217

2318
# Getting Started
2419

@@ -30,79 +25,73 @@ of the [OpenTelemetry Java SDK](https://github.com/open-telemetry/opentelemetry-
3025
> context for this workaround, please see
3126
> [this issue](https://issuetracker.google.com/issues/230454566#comment18).
3227
33-
For an overview of how to contribute, see the contributing guide
34-
in [CONTRIBUTING.md](CONTRIBUTING.md).
35-
36-
We are also available in the [#otel-android](https://cloud-native.slack.com/archives/C05J0T9K27Q)
37-
channel in the [CNCF slack](https://slack.cncf.io/). Please join us there for further discussions.
38-
39-
## Gradle
28+
## Gradle Setup
4029

41-
To use this android instrumentation library in your application, you will first need to add
30+
To use the Android Agent in your application, you will first need to add
4231
a dependency in your application's `build.gradle.kts`. We publish a bill of materials (BOM) that
43-
helps to coordinate versions of the opentelemetry-android components and the upstream
32+
helps to coordinate versions of the this project's components and the upstream
4433
`opentelemetry-java-instrumentation` and `opentelemetry-java` dependencies. We recommend
45-
using the bom as a platform dependency, and then omitting explicit version information
34+
using the BOM as a platform dependency, and then omitting explicit version information
4635
from all other opentelemetry dependencies:
4736

4837
```kotlin
4938
dependencies {
5039
//...
51-
api(platform("io.opentelemetry.android:opentelemetry-android-bom:0.16.0-alpha"))
52-
implementation("io.opentelemetry.android:android-agent") // Version is resolved thru bom
40+
api(platform("io.opentelemetry.android:opentelemetry-android-bom:<version>"))
41+
implementation("io.opentelemetry.android:android-agent") // Version is resolved through the BOM
5342
//...
5443
}
5544
```
5645

5746
# Features
5847

59-
This android library builds on top of
60-
the [OpenTelemetry Java SDK](https://github.com/open-telemetry/opentelemetry-java).
61-
Some of the additional features provided include:
48+
In addition to exposing the OTel Java API for manual instrumentation, agent also offers the following features:
49+
50+
* Streamlined initialization and configuration of the Java SDK instance
51+
* Installation and management of bundled instrumentation
52+
* Offline buffering of telemetry via disk persistence
53+
* Redact and change span attributes before export
54+
55+
## Instrumentation
56+
57+
The following instrumentations are bundled with the Android Agent:
6258

6359
* [Crash reporting](./instrumentation/crash/)
6460
* [ANR detection](./instrumentation/anr/)
6561
* [Network change detection](./instrumentation/network/)
66-
* Android [Activity lifecycle instrumentation](./instrumentation/activity/)
67-
* Android [Fragment lifecycle monitoring](./instrumentation/fragment)
68-
* [View click instrumentation](./instrumentation/view-click/)
69-
* Access to the OpenTelemetry APIs for manual instrumentation
70-
* Helpers to redact any span from export, or change span attributes before export
71-
* [Slow / frozen render detection](./instrumentation/slowrendering)
72-
* Offline buffering of telemetry via storage
73-
74-
Note: Use of these features is not yet well documented.
75-
76-
## StrictMode
62+
* [Activity lifecycle](./instrumentation/activity/)
63+
* [Fragment lifecycle](./instrumentation/fragment)
64+
* [View click](./instrumentation/view-click/)
65+
* [Slow/frozen frame render detection](./instrumentation/slowrendering)
7766

78-
For guidance on Android StrictMode violations (disk / network I/O warnings) triggered by SDK initialization
79-
and instrumentation, expected one-time operations, plus available mitigations and workarounds, see
80-
[StrictMode Policy](./docs/STRICTMODE.md).
67+
## Additional Documentation
8168

82-
## Exporter Chain
69+
See the following pages for details about the related topics:
8370

84-
The SDK performs asynchronous exporter initialization with an in-memory buffering layer and optional
85-
disk buffering for offline scenarios. See [Exporter Chain documentation](./docs/EXPORTER_CHAIN.md)
86-
for details, customization hooks, and ordering semantics.
71+
- [StrictMode Guidance](./docs/STRICTMODE.md)
72+
- [Exporter Management](./docs/EXPORTER_CHAIN.md)
8773

8874
# Contributing
8975

90-
See [CONTRIBUTING.md](CONTRIBUTING.md).
76+
For an overview of how to contribute, see the contributing guide in [CONTRIBUTING.md](CONTRIBUTING.md).
77+
78+
We are also available in the [#otel-android](https://cloud-native.slack.com/archives/C05J0T9K27Q)
79+
channel in the [CNCF Slack](https://slack.cncf.io/). Please join us there for further discussions.
9180

92-
### Maintainers
81+
## Maintainers
9382

9483
- [Cesar Munoz](https://github.com/likethesalad), Elastic
9584
- [Jason Plumb](https://github.com/breedx-splk), Splunk
9685

9786
For more information about the maintainer role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#maintainer).
9887

99-
### Approvers
88+
## Approvers
10089

10190
- [Hanson Ho](https://github.com/bidetofevil), Embrace
10291
- [Jamie Lynch](https://github.com/fractalwrench), Embrace
10392
- [Manoel Aranda Neto](https://github.com/marandaneto), PostHog
10493

105-
For more information about the approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).
94+
For more information about the Approver role, see the [community repository](https://github.com/open-telemetry/community/blob/main/guides/contributor/membership.md#approver).
10695

10796
[ci-image]: https://github.com/open-telemetry/opentelemetry-android/actions/workflows/build.yaml/badge.svg
10897

0 commit comments

Comments
 (0)