Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/grofers/droid-dex

Classification and Analysis of Android Device Performance
https://github.com/grofers/droid-dex

android android-library performance performance-analysis performance-monitoring

Last synced: about 1 month ago
JSON representation

Classification and Analysis of Android Device Performance

Host: GitHub
URL: https://github.com/grofers/droid-dex
Owner: grofers
License: apache-2.0
Created: 2024-02-22T06:24:56.000Z (12 months ago)
Default Branch: master
Last Pushed: 2024-04-04T12:18:17.000Z (10 months ago)
Last Synced: 2024-12-22T10:34:50.522Z (about 2 months ago)
Topics: android, android-library, performance, performance-analysis, performance-monitoring
Language: Kotlin
Homepage:
Size: 963 KB
Stars: 22
Watchers: 7
Forks: 0
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-list - grofers/droid-dex - Classification and Analysis of Android Device Performance (Kotlin)

README

![Droid Dex](./assets/logo.png)

## Introduction

Droid Dex is a powerful tool crafted to enhance the performance of your Android applications, ultimately elevating the
user experience. With a focus on addressing key performance issues, it is your solution for addressing prevalent
challenges like Jerky(Janky) Scrolling, Out of Memory errors (OOMs), High Battery Consumption, and instances of
Application Not Responding (ANR).

It classifies and lets you analyze Android Device Performance across various parameters like:

| PARAMETER | DESCRIPTION |
|----------------------------------------------------------------------------------------------------------------------------|-----------------------------------------------------|
|

[CPU](./droid-dex/src/main/kotlin/com/blinkit/droiddex/cpu/CpuPerformanceManager.kt)

| Total RAM, Core Count, CPU Frequency |
|

[MEMORY](./droid-dex/src/main/kotlin/com/blinkit/droiddex/memory/MemoryPerformanceManager.kt)

| Heap Limit, Heap Remaining, Available RAM |
|

[NETWORK](./droid-dex/src/main/kotlin/com/blinkit/droiddex/network/NetworkPerformanceManager.kt)

| Bandwidth Strength, Download Speed, Signal Strength |
|

[STORAGE](./droid-dex/src/main/kotlin/com/blinkit/droiddex/storage/StoragePerformanceManager.kt)

| Available Storage |
|

[BATTERY](./droid-dex/src/main/kotlin/com/blinkit/droiddex/battery/BatteryPerformanceManager.kt)

| Percentage Remaining, If Phone is Charging or Not |

into various [levels](./droid-dex/src/main/kotlin/com/blinkit/droiddex/constants/PerformanceLevel.kt): EXCELLENT, HIGH,
AVERAGE, LOW

It is a compact library accompanied by extensive in-line documentation, providing users with the opportunity to delve
into the code, comprehend each line thoroughly, and, ideally, contribute to its development.

## Use Cases

1. Consider a scenario where background polling of an API is necessary. In this context, the `BATTERY` level becomes a
crucial factor, as frequent polling can significantly drain the device's battery. To address this concern, you can
optimize the process using the following code snippet:

```Kotlin
DroidDex.getPerformanceLevelLd(PerformanceClass.BATTERY).observe(this) {
// Adjust the polling time interval
}
```

2. Consider a scenario where you need to tailor the image quality for users based on their devices. In this context, the
`NETWORK` condition plays a crucial role in decision-making, as achieving better image quality typically involves
larger file sizes and increased data transfer. However, `MEMORY` is also a consideration, as higher-quality images
generate heavier bitmaps, consuming more memory. To optimize this process, you can use the following code snippet:

```Kotlin
DroidDex.getWeightedPerformanceLevelLd(PerformanceClass.NETWORK to 2F, PerformanceClass.MEMORY to 1F).observe(this) {
// Implement image quality optimization
}
```

## Usage

Initialize the library in your Application class using the following code snippet:

```Kotlin
DroidDex.init(this, BuildConfig.DEBUG)
```

The first parameter requires the `Application Context`, while the second parameter determines whether the user is in
`Debug Mode`, enabling extensive logging.

1. To get performance level for single/multiple parameters:

```Kotlin
DroidDex.getPerformanceLevel(params)
```

For observing the changes:

```Kotlin
DroidDex.getPerformanceLevelLd(params).observe(this) {
}
```

Replace `params` with comma separated list of `Performance Class(es)`.

Example:
```Kotlin
DroidDex.getPerformanceLevel(PerformanceClass.CPU, PerformanceClass.MEMORY)
```

2. To get performance level for multiple parameters with unequal weights:

```Kotlin
DroidDex.getWeightedPerformanceLevel(params)
```

For observing the changes:

```Kotlin
DroidDex.getWeightedPerformanceLevelLd(params).observe(this) {
}
```

Replace `params` with comma separated list of `Performance Classes` to their `Weights`.

Example:
```Kotlin
DroidDex.getWeightedPerformanceLevelLd(PerformanceClass.CPU to 2F, PerformanceClass.MEMORY to 1F).observe(this) {
}
```

See [Example Project](https://github.com/grofers/droid-dex/tree/main/example) for Further Usage

## Download

Kotlin DSL

Add this to your root `settings.gradle.kts`

```Kotlin
dependencyResolutionManagement {
repositories {
maven {
url = URI("https://maven.pkg.github.com/grofers/*")
credentials {
username = "Blinkit"
password = GITHUB_PERSONAL_ACCESS_TOKEN
}
}
}
}
```

And add this dependency to your project level `build.gradle.kts`:

```Kotlin
dependencies {
implementation("com.blinkit.kits:droid-dex:x.y.z")
}
```

Groovy

Add this to your root `settings.gradle`

```Groovy
dependencyResolutionManagement {
repositories {
maven {
url "https://maven.pkg.github.com/grofers/*"
credentials {
username = "Blinkit"
password = GITHUB_PERSONAL_ACCESS_TOKEN
}
}
}
}
```

And add this dependency to your project level `build.gradle`:

```Groovy
dependencies {
implementation "com.blinkit.kits:droid-dex:x.y.z"
}
```

## License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.