Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightstep/lightstep-tracer-android
The Lightstep distributed tracing library for Android.
https://github.com/lightstep/lightstep-tracer-android
opentracing
Last synced: 8 days ago
JSON representation
The Lightstep distributed tracing library for Android.
- Host: GitHub
- URL: https://github.com/lightstep/lightstep-tracer-android
- Owner: lightstep
- License: mit
- Created: 2017-06-26T21:25:51.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2023-09-15T21:05:45.000Z (about 1 year ago)
- Last Synced: 2024-11-07T19:08:33.579Z (8 days ago)
- Topics: opentracing
- Language: Java
- Homepage: https://lightstep.com
- Size: 39 MB
- Stars: 8
- Watchers: 66
- Forks: 1
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# lightstep-tracer-android
[  ](https://bintray.com/lightstep/maven/) [](https://circleci.com/gh/lightstep/lightstep-tracer-android) [](http://opensource.org/licenses/MIT)
The LightStep distributed tracing library for Android.
* [Getting Started](#getting-started)
* [Android](#getting-started-android)
* [API documentation](#apidocs)
* [Options](#options)
## Getting started: Android
The Android library is hosted on Bintray, jcenter, and Maven Central. The Bintray [lightstep-tracer-android](https://bintray.com/lightstep/maven/lightstep-tracer-android/view) project contains additional installation and setup information for using the library with various build systems such as Ivy and Maven.
### Gradle
In most cases, modifying your `build.gradle` with the below is all that is required:
```
repositories {
jcenter() // OR mavenCentral()
}
dependencies {
compile 'com.lightstep.tracer:lightstep-tracer-android:VERSION'
}
```
* If using the `grpc` transport, use the **0.3x.x** version family.
* If using the `okhttp` transport, use the **0.2x.x** version family. **This is the recommended deployment**.
See more in the [Maven](#maven) section and Gradle sections.
### Update your AndroidManifest.xml
Ensure the app's `AndroidManifest.xml` has the following (under the `` tag):
```xml
```
### Initializing the LightStep Tracer
```java
// Import the OpenTracing interfaces
import io.opentracing.Span;
import io.opentracing.Tracer;
// ...
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
// Initialize LightStep tracer implementation in the main activity
// (or anywhere with a valid android.content.Context).
this.tracer = new com.lightstep.tracer.android.Tracer(
this,
new com.lightstep.tracer.shared.Options.OptionsBuilder()
.withAccessToken("{your_access_token}")
.build()
);
// Start and finish a Span
Span span = this.tracer.buildSpan("my_span").start();
this.doSomeWorkHere();
span.finish();
```
Tracing instrumentation should use the OpenTracing APIs to stay portable and in sync with the standard:
* [OpenTracing API (javadoc)](http://javadoc.io/doc/io.opentracing/opentracing-api)
For reference, the generated LightStep documentation is also available:
* [lightstep-tracer-android (javadoc)](http://javadoc.io/doc/com.lightstep.tracer/lightstep-tracer-android)
## Options
### Setting a custom component name
To set the name used in the LightStep UI for this instance of the Tracer, call `withComponentName()` on the `OptionsBuilder` object:
```java
options = new com.lightstep.tracer.shared.Options.OptionsBuilder()
.withAccessToken("{your_access_token}")
.withComponentName("your_custom_name")
.build();
```
### Disabling the reporting loop
By default, the Java library does a report of any buffered data on a fairly regular interval. To disable this behavior and rely only on explicit calls to `flush()` to report data, initialize with:
```java
options = new com.lightstep.tracer.shared.Options.OptionsBuilder()
.withAccessToken("{your_access_token}")
.withDisableReportingLoop(true)
.build();
```
To then manually flush by using the LightStep tracer object directly:
```java
// Flush any buffered tracing data
((com.lightstep.tracer.android.Tracer)tracer).flush();
```
### Flushing the report at exit
In order to send a final flush of the data prior to exit, clients should manually flush by using the LightStep tracer object as described above.
### Disabling default clock correction
By default, the Java library performs clock correction based on timestamp information provided in the spans. To disable this behavior, initialize with:
```java
options = new com.lightstep.tracer.shared.Options.OptionsBuilder()
.withAccessToken("{your_access_token}")
.withClockSkewCorrection(false)
.build();
```
### Advanced Option: Transport and Serialization Protocols
By following the above configuration, the tracer will send information to LightStep using HTTP and Protocol Buffers which is the recommended configuration. If there are no specific transport protocol needs you have, there is no need to change this default.
There are two options for transport protocols:
- [Protocol Buffers](https://developers.google.com/protocol-buffers/) over HTTP using [OkHttp 3](http://square.github.io/okhttp/) - The recommended and default solution. Supported in the 0.25.x version family, as OkHttp 3 runs under the supported Android versions.
- [Protocol Buffers](https://developers.google.com/protocol-buffers/) over [GRPC](https://grpc.io/) - This is a more advanced solution that might be desirable if you already have gRPC networking configured. Use the 0.30.x version family.
You can configure the tracer to support gRPC by replacing `com.lightstep.tracer:tracer-okhttp` with `com.lightstep.tracer:tracer-grpc` when including the tracer dependency and including a grpc dependency. i.e.
#### Maven
```xml
com.lightstep.tracer
lightstep-tracer-android
VERSION
com.lightstep.tracer
tracer-grpc
VERSION
```
#### Gradle
```
repositories {
mavenCentral() // OR jcenter()
}
dependencies {
compile 'com.lightstep.tracer:lightstep-tracer-android:VERSION'
// Additional dependency if using the grpc/0.3x.x family
compile 'com.lightstep.tracer:tracer-grpc:VERSION'
}
```
## Development info
See [DEV.md](DEV.md) for information on contributing to this instrumentation library.