git.iko.soy/parseable-android
on e98fa28 help sign in
parseable-android/README.md
71 lines 3.1 kB history raw
1# Parseable Android
3An Android client for [Parseable](https://www.parseable.com/), the open-source log analytics platform. Browse, search, and filter your log data from your phone.
5## Features
7- **Server Connection** — Connect to any Parseable instance with Basic Auth. Supports both HTTP and HTTPS. Credentials are persisted locally.
8- **Stream Browser** — View all log streams with ingestion/storage stats at a glance.
9- **Log Viewer** — Browse log entries with expandable detail cards. Tap any entry to see all fields.
10- **Time Range Filtering** — Quick-select time ranges from 5 minutes to 30 days.
11- **Text Search** — Full-text search across log fields with automatic fallback strategies.
12- **Column Filters** — Add SQL-based column filters with operators (=, !=, LIKE, ILIKE, >, <, IS NULL, etc.).
13- **Custom SQL Queries** — Write and execute raw PostgreSQL-compatible SQL directly against your log data.
14- **Stream Details** — View schema, stats (event count, ingestion size, storage size), and retention config per stream.
15- **Alerts** — Browse configured alerts with rule and target details.
16- **Settings** — View server info (version, mode, deployment ID, query engine) and user list.
17- **Dark Mode** — Full Material 3 dark/light theme support following system preference.
18- **Pull-to-Refresh** — Pull to refresh on all list screens.
20## Tech Stack
22- Kotlin
23- Jetpack Compose with Material 3
24- Hilt for dependency injection
25- OkHttp for networking
26- Kotlinx Serialization for JSON
27- DataStore for local preferences
28- Navigation Compose for routing
30## Parseable API Coverage
32| Endpoint | Method | Used For |
33|---|---|---|
34| `/api/v1/liveness` | GET | Connection test |
35| `/api/v1/about` | GET | Server info |
36| `/api/v1/logstream` | GET | List streams |
37| `/api/v1/logstream/{name}/schema` | GET | Stream schema |
38| `/api/v1/logstream/{name}/stats` | GET | Stream statistics |
39| `/api/v1/logstream/{name}/info` | GET | Stream details |
40| `/api/v1/logstream/{name}/retention` | GET | Retention config |
41| `/api/v1/logstream/{name}` | DELETE | Delete stream |
42| `/api/v1/query` | POST | SQL log queries |
43| `/api/v1/alerts` | GET | List alerts |
44| `/api/v1/user` | GET | List users |
46## Installation
48The recommended way to install Parseable Android is via [Obtainium](https://github.com/ImranR98/Obtainium), which will automatically notify you of new releases.
501. Install [Obtainium](https://github.com/ImranR98/Obtainium) on your device.
512. Open Obtainium and tap **Add App**.
523. Enter this repository URL: `https://github.com/ilyakooo0/parseable-android`
534. Tap **Add** — Obtainium will fetch the latest release APK and install it.
55Updates will be detected automatically whenever a new release is published.
57## Building
59```bash
60./gradlew assembleDebug
61```
63The debug APK will be at `app/build/outputs/apk/debug/`.
65## CI/CD
67The GitHub Actions workflow (`.github/workflows/build-release.yml`) builds both debug and release APKs. Pushing a tag matching `v*` creates a draft GitHub release with the APKs attached. You can also trigger the workflow manually.
69## License
71MIT