Skip to content

Commit d27b4fd

Browse files
Archish27Archish27
committed
🎨 initial commit for android sdk
0 parents  commit d27b4fd

File tree

80 files changed

+3346
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+3346
-0
lines changed

‎.gitignore

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
*.iml
2+
.gradle
3+
/local.properties
4+
/.idea/caches
5+
/.idea/libraries
6+
/.idea/modules.xml
7+
/.idea/workspace.xml
8+
/.idea/navEditor.xml
9+
/.idea/assetWizardSettings.xml
10+
.DS_Store
11+
/build
12+
/captures
13+
.externalNativeBuild
14+
.cxx
15+
local.properties

‎.idea/.gitignore

+3
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/compiler.xml

+6
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/deploymentTargetDropDown.xml

+17
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/gradle.xml

+21
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/inspectionProfiles/Project_Default.xml

+8
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎.idea/misc.xml

+9
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎README.md

+191
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,191 @@
1+
# Middleware Instrumentation Android SDK
2+
3+
## Features
4+
- Android Activity & Fragment lifecycle events
5+
- Crash Reporting
6+
- ANR Dectection
7+
- Network Change Detection
8+
- Slow / Freeze render detection
9+
- OkHttp3 instrumention for monitoring http events
10+
- Middleware APIs for sending custom events & record exceptions
11+
- Access to OpenTelemetry APIs
12+
13+
## Setup
14+
15+
16+
### Install Middleware Android SDK
17+
18+
```groovy
19+
implementation 'io.middleware.android:sdk:+'
20+
```
21+
22+
### Configure of Middleware Android Instrumentation
23+
24+
```java
25+
26+
class MyApplication extends Application {
27+
private final String targetUrl = "<target-url>";
28+
private final String rumAccessToken = "<your-access-token>";
29+
30+
@Override
31+
public void onCreate() {
32+
super.onCreate();
33+
34+
Middleware.builder()
35+
.setTarget(targetUrl)
36+
.setServiceName("sample-android-app-1")
37+
.setProjectName("Mobile-SDK-Android")
38+
.setRumAccessToken(rumAccessToken)
39+
.setSlowRenderingDetectionPollInterval(Duration.ofMillis(1000))
40+
.setDeploymentEnvironment("PROD")
41+
.build(this);
42+
}
43+
44+
```
45+
46+
## Documentation
47+
48+
### Configurations
49+
50+
Methods that can be used for setting instrumentation & configure your application.
51+
52+
<table>
53+
<thead>
54+
<tr><td>Option</td><td>Description</td><tr>
55+
</thead>
56+
<tbody>
57+
<tr>
58+
<td>
59+
<code lang="java">setRumAccessToken(String)</code>
60+
</td>
61+
<td>
62+
Sets the RUM account access token to authorize client to send telemetry data to Middleware
63+
</td>
64+
</tr>
65+
66+
<tr>
67+
<td>
68+
<code lang="java">setTarget(String)</code>
69+
</td>
70+
<td>
71+
Sets the target URL to which you want to send telemetry data. For example - https://app.middleware.io
72+
</td>
73+
</tr>
74+
75+
<tr>
76+
<td>
77+
<code lang="java">setService(String)</code>
78+
</td>
79+
<td>
80+
Sets the service name for your application. This can be used furthur for filtering by service name.
81+
</td>
82+
</tr>
83+
84+
<tr>
85+
<td>
86+
<code lang="java">setDeploymentEnvironment(String)</code>
87+
</td>
88+
<td>
89+
Sets the environment attribute on the spans that are generated by the instrumentation. For Example - <code>PROD</code> | <code> DEV </code>
90+
</td>
91+
</tr>
92+
93+
<tr>
94+
<td>
95+
<code lang="java">disableCrashReporting()</code>
96+
</td>
97+
<td>
98+
Disable crash reporting. By default it is enabled.
99+
</td>
100+
</tr>
101+
102+
<tr>
103+
<td>
104+
<code lang="java">disableAnrDetection()</code>
105+
</td>
106+
<td>
107+
Disable Application Not Responding Detection. By default it is enabled.
108+
</td>
109+
</tr>
110+
<tr>
111+
<td>
112+
<code lang="java">disableNetworkMonitor()</code>
113+
</td>
114+
<td>
115+
Disable network change detection. By default it is enabled.
116+
</td>
117+
</tr>
118+
<tr>
119+
<td>
120+
<code lang="java">disableSlowRenderingDetection()</code>
121+
</td>
122+
<td>
123+
Disable slow or frozen frame renders. By default it is enabled.
124+
</td>
125+
</tr>
126+
<tr>
127+
<td>
128+
<code lang="java">setSlowRenderingDetectionPollInterval(Duration)</code>
129+
</td>
130+
<td>
131+
Sets the deafult polling for slow or frozen render detection. Default value in milliseconds is <code>1000</code>
132+
</td>
133+
</tr>
134+
</tbody>
135+
</table>
136+
137+
### HTTP Instrumentation Configuration
138+
139+
#### OkHttp
140+
141+
```java
142+
private Call.Factory buildOkHttpClient(Middleware middleware) {
143+
return middleware.createRumOkHttpCallFactory(new OkHttpClient());
144+
}
145+
```
146+
147+
### Manually instrumentation for android application
148+
149+
#### Global Attributes
150+
151+
152+
Global attributes are key-value pairs that are used for attaching the global information for the reported data. These values can be useful for custom or user specific tags that can be attached while sending data to Middleware.
153+
154+
##### How to set global attributes?
155+
156+
```java
157+
Middleware.builder()
158+
.setGlobalAttributes(
159+
Attributes.builder()
160+
.put("key", "value")
161+
.put(StandardAttributes.APP_VERSION, BuildConfig.VERSION_NAME)
162+
.build());
163+
```
164+
165+
#### Custom Events
166+
167+
You can also send custom events and workflows using <code>addEvent</code> and <code>startWorkflow</code> APIs respectively
168+
169+
##### How to send custom event?
170+
```java
171+
Middleware.getInstance().addEvent("You clicked on Button", BUTTON_ATTRIBUES);
172+
```
173+
174+
##### How to start workflow?
175+
```java
176+
Span loginWorkflow = Middleware.getInstance().startWorkflow("User Login Flow");
177+
```
178+
179+
##### How to end workflow?
180+
```java
181+
loginWorkflow.end();
182+
```
183+
184+
#### Configure error reporting
185+
186+
You can report exceptions, errors and any messages using `addException(Throwable)` We will show this on our Middleware Dashboard.
187+
188+
```java
189+
Middleware.getInstance().addException(new RuntimeException("Something went wrong!"), Attributes.empty())
190+
```
191+

‎app/.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
/build

‎app/build.gradle

+54
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
plugins {
2+
id 'com.android.application'
3+
}
4+
5+
android {
6+
namespace 'io.middleware.android.sample'
7+
compileSdk 34
8+
9+
defaultConfig {
10+
applicationId "io.middleware.android.sample"
11+
minSdk 26
12+
targetSdk 33
13+
versionCode 1
14+
versionName "1.0"
15+
16+
testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
17+
}
18+
19+
buildTypes {
20+
release {
21+
minifyEnabled false
22+
proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
23+
}
24+
}
25+
compileOptions {
26+
sourceCompatibility JavaVersion.VERSION_1_8
27+
targetCompatibility JavaVersion.VERSION_1_8
28+
}
29+
}
30+
31+
dependencies {
32+
implementation 'io.opentelemetry.instrumentation:opentelemetry-instrumentation-bom-alpha:1.31.0-alpha'
33+
implementation 'androidx.appcompat:appcompat:1.6.1'
34+
implementation 'com.google.android.material:material:1.10.0'
35+
implementation 'androidx.constraintlayout:constraintlayout:2.1.4'
36+
implementation("androidx.appcompat:appcompat:1.6.1")
37+
implementation("androidx.webkit:webkit:1.8.0")
38+
implementation("androidx.browser:browser:1.6.0")
39+
implementation project(path: ':sdk')
40+
41+
implementation "io.opentelemetry.instrumentation:opentelemetry-instrumentation-api"
42+
implementation "io.opentelemetry.instrumentation:opentelemetry-instrumentation-api-semconv"
43+
implementation 'io.opentelemetry.instrumentation:opentelemetry-okhttp-3.0:1.31.0-alpha'
44+
implementation("io.opentelemetry:opentelemetry-api-events")
45+
implementation("io.opentelemetry:opentelemetry-sdk-logs")
46+
implementation("io.opentelemetry:opentelemetry-sdk")
47+
implementation("androidx.navigation:navigation-fragment:2.7.4")
48+
implementation("androidx.navigation:navigation-ui:2.7.4")
49+
implementation 'androidx.work:work-runtime:2.8.1'
50+
testImplementation 'junit:junit:4.13.2'
51+
androidTestImplementation 'androidx.test.ext:junit:1.1.5'
52+
androidTestImplementation 'androidx.test.espresso:espresso-core:3.5.1'
53+
54+
}

‎app/proguard-rules.pro

+21
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
# Add project specific ProGuard rules here.
2+
# You can control the set of applied configuration files using the
3+
# proguardFiles setting in build.gradle.
4+
#
5+
# For more details, see
6+
# http://developer.android.com/guide/developing/tools/proguard.html
7+
8+
# If your project uses WebView with JS, uncomment the following
9+
# and specify the fully qualified class name to the JavaScript interface
10+
# class:
11+
#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
12+
# public *;
13+
#}
14+
15+
# Uncomment this to preserve the line number information for
16+
# debugging stack traces.
17+
#-keepattributes SourceFile,LineNumberTable
18+
19+
# If you keep the line number information, uncomment this to
20+
# hide the original source file name.
21+
#-renamesourcefileattribute SourceFile

‎app/src/androidTest/java/io/middleware/android/sample/ExampleInstrumentedTest.java

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
package io.middleware.android.sample;
2+
3+
import android.content.Context;
4+
5+
import androidx.test.platform.app.InstrumentationRegistry;
6+
import androidx.test.ext.junit.runners.AndroidJUnit4;
7+
8+
import org.junit.Test;
9+
import org.junit.runner.RunWith;
10+
11+
import static org.junit.Assert.*;
12+
13+
/**
14+
* Instrumented test, which will execute on an Android device.
15+
*
16+
* @see <a href="http://d.android.com/tools/testing">Testing documentation</a>
17+
*/
18+
@RunWith(AndroidJUnit4.class)
19+
public class ExampleInstrumentedTest {
20+
@Test
21+
public void useAppContext() {
22+
// Context of the app under test.
23+
Context appContext = InstrumentationRegistry.getInstrumentation().getTargetContext();
24+
assertEquals("io.middleware.android.sample", appContext.getPackageName());
25+
}
26+
}

0 commit comments

Comments
 (0)