https://github.com/moesif/moesif-android
Moesif SDK for Android
https://github.com/moesif/moesif-android
android api api-client logger logging logging-library okhttp3 okhttp3-integration okhttp3-logginginterceptor volley
Last synced: 5 days ago
JSON representation
Moesif SDK for Android
- Host: GitHub
- URL: https://github.com/moesif/moesif-android
- Owner: Moesif
- License: other
- Created: 2016-10-23T23:02:07.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2024-11-15T19:41:43.000Z (5 months ago)
- Last Synced: 2025-04-01T20:51:33.313Z (26 days ago)
- Topics: android, api, api-client, logger, logging, logging-library, okhttp3, okhttp3-integration, okhttp3-logginginterceptor, volley
- Language: Java
- Homepage: https://www.moesif.com
- Size: 79.1 KB
- Stars: 7
- Watchers: 7
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This repo is deprecated, for capture outgoing API calls in Java/Kotlin envinroment, including Android, we recommend
https://github.com/Moesif/moesif-java-okhttp-interceptor
# Moesif SDK for Android
[![Built For][ico-built-for]][link-built-for]
[![Latest Version][ico-version]][link-package]
[![Software License][ico-license]][link-license]
[![Source Code][ico-source]][link-source]
moesif-android is a SDK that automatically captures HTTP traffic such as to your internal APIs or external APIs like Stripe
and sends to [Moesif](https://www.moesif.com) for API analytics and log analysis.
## Requirements
This lib requires the use of OkHttp 2.2 or better. OkHttp 3.x is also supported.
The two popular Android networking clients (Volley and Retrofit) support using OkHttp so you are probably fine if using one of these two libs.
If using Retrofit, 1.9 or greater is required.
If using Volley, a simple one line change is required to use our MoesifOkHttpXStack.
## Module Structure
__moesif-android:__
The core SDK shared across platforms, imported automatically by the below HTTP stack specific modules.
__moesif-android-okhttp3:__
Supports the latest version (3.x) of OkHttp
__moesif-android-okhttp2:__
If you want to stick with OkHttp 2.x for legacy reasons, import this module instead of moesif-android-okhttp3
## How To Configure:
### 1. Add the dependency to your app/build.gradle
```gradle
# Add the jcenter repository, if not present
repositories {
jcenter()
}
dependencies {
compile 'com.moesif.android:moesif-android-okhttp3:1.1.2'
}
```
If your Android project imports Volley as an unmanaged artifact, you may have to exclude volley as a transitive dependency:
Otherwise, you may get duplicate class errors.
```gradle
# Add the jcenter repository, if not present
repositories {
jcenter()
}
dependencies {
compile ('com.moesif.android:moesif-android-okhttp3:1.1.2') {
exclude group: 'com.android.volley'
}
}
```
### 2. In your AndroidManifest.xml, add your Moesif ApplicationId under the "application" node:
Your Moesif Application Id can be found in the [_Moesif Portal_](https://www.moesif.com/).
After signing up for a Moesif account, your Moesif Application Id will be displayed during the onboarding steps.
You can always find your Moesif Application Id at any time by logging
into the [_Moesif Portal_](https://www.moesif.com/), click on the top right menu,
and then clicking _Installation_.
```xml
```
### 3. In your Application's onCreate(), initialize the lib
```java
import com.moesif.android.MoesifClient;
public final class MyApplicationClass extends Application {
@Override
public void onCreate() {
MoesifClient.initialize(this);
}
}
```
### 4. Add the Interceptor
#### 4.a If using Retrofit/OkHttp3 natively:
Add the Moesif MoesifOkHttp3Interceptor when building the Retrofit/OkHttp Client.
If you have existing interceptors, you probably want Moesif's interceptor last in the chain to ensure it captures the HTTP call
just before going over the wire.
[See more Info on using OkHttp Interceptors](https://github.com/square/okhttp/wiki/Interceptors)
```java
import com.moesif.android.okhttp3;
OkHttpClient client = new OkHttpClient.Builder()
.addInterceptor(new MoesifOkHttp3Interceptor())
.build();
```
#### 4.a If using Volley:
Pass in a new MoesifOkHttp3Stack object when creating Volley's request queue.
[See more info on setting up volley](https://developer.android.com/training/volley/requestqueue.html)
```java
import com.moesif.android.okhttp3;
RequestQueue queue = Volley.newRequestQueue(myContext.getApplicationContext(),
new MoesifOkHttp3Stack());
```
## Configuring using OkHttp2:
Follow the previous configuration steps, except a few changes:
### 1. Import moesif-android-okhttp2 instead
```gradle
# Add the jcenter repository, if not present
repositories {
jcenter()
}
dependencies {
compile 'com.moesif.android:moesif-android-okhttp2:1.1.2'
}
```
### 2. Use the corresponding OkHttp2 classes instead.
#### 2.a If using Retrofit/OkHttp3 natively:
```java
import com.moesif.android.okhttp2;
OkHttpClient myHttpClient new OkHttpClient();
myHttpClient.networkInterceptors().add(new MoesifOkHttp2Interceptor());
```
#### 2.a Or Volley:
```java
import com.moesif.android.okhttp2;
RequestQueue queue = Volley.newRequestQueue(myContext.getApplicationContext(),
new MoesifOkHttp2Stack(new OkHttpClient()));
```
## License info for the Android SDK
See [LICENSE File](https://raw.githubusercontent.com/Moesif/moesif-android/master/LICENSE) for details. The MoesifOkHttp3Stack and
MoesifOkHttp2Stack classes, and the entirety of the com.moesif.android.inspector package used by this
software have been licensed from non-Moesif sources and modified
for use in the library. Please see the relevant source files, and the
LICENSE file in the com.moesif.android.inspector package for details.
## Other Integrations
To view more more documenation on integration options, please visit __[the Integration Options Documentation](https://www.moesif.com/docs/getting-started/integration-options/).__
[ico-built-for]: https://img.shields.io/badge/built%20for-android-blue.svg
[ico-version]: https://api.bintray.com/packages/moesif/maven/moesif-android/images/download.svg
[ico-license]: https://img.shields.io/badge/License-Apache%202.0-green.svg
[ico-source]: https://img.shields.io/github/last-commit/moesif/moesif-android.svg?style=social
[link-built-for]: https://developer.android.com/
[link-package]: https://bintray.com/moesif/maven/moesif-android/_latestVersion
[link-license]: https://raw.githubusercontent.com/Moesif/moesif-android/master/LICENSE
[link-source]: https://github.com/moesif/moesif-android