Skip to content

Home

Jump to bottom
Dmitry Sorokin (@sorydima) edited this page Nov 18, 2024 · 1 revision

Wiki for the Katya ® LogViewer Repository

Welcome to the Katya ® LogViewer repository! This wiki provides all the information needed to understand, use, and contribute to the LogViewer application, a vital tool for debugging and monitoring the Katya ecosystem.

Overview

The Katya LogViewer application is a powerful tool for analyzing and debugging system logs. It provides developers and system administrators with a user-friendly interface for filtering, searching, and exporting logs, ensuring efficient troubleshooting and system optimization.

Table of Contents

  1. Getting Started
  2. Repository Structure
  3. Features
  4. Installation
  5. Configuration
  6. Contributing
  7. Troubleshooting
  8. Licensing

Getting Started

  1. Clone the Repository

    git clone https://github.com/Katya-Incorporated/platform_packages_apps_LogViewer.git

  2. Set Up Development Tools
    Ensure you have Android Studio or another compatible IDE with the required dependencies installed.

  3. Explore the Features
    Familiarize yourself with the app's capabilities by reading this wiki or reviewing the codebase.

Repository Structure

  • /src: Contains the main application code.
  • /res: UI resources like layouts, icons, and strings.
  • /docs: Additional documentation for developers and users.
  • /tests: Automated test cases to ensure reliability.
  • /build: Build scripts and related files.

Features

  1. Log Filtering

    • Filter logs by priority (e.g., Debug, Warning, Error) or specific tags.

  2. Real-Time Log Monitoring

    • Stream and view logs in real-time from connected devices or emulators.

  3. Search Functionality

    • Quickly locate specific log entries with a powerful search feature.

  4. Export Logs

    • Save logs as files for offline analysis or sharing.

  5. Customizable UI

    • Personalize the interface to suit your workflow.

Installation

  1. Build the Application
    Use the following Gradle command to build the application:

    ./gradlew assembleDebug

  2. Install the APK
    Deploy the APK to a device or emulator:

    adb install -r app/build/outputs/apk/debug/app-debug.apk

  3. Run the Application
    Open the LogViewer app to start viewing and analyzing logs.

Configuration

  1. Default Log Levels
    Configure default log levels (e.g., DEBUG, INFO) in the Settings module.

  2. Custom Filters
    Define custom filters in the /src/config folder to tailor log views to specific needs.

  3. Export Formats
    Adjust export settings for logs (e.g., JSON, TXT) in the /src/utils directory.

Contributing

We encourage contributions to make the LogViewer app even better!

  1. Fork the Repository
    Create a copy of the repository in your GitHub account.

  2. Create a Branch
    Use descriptive branch names for your changes.

  3. Write Code and Tests
    Make your modifications and write tests to validate them.

  4. Submit a Pull Request
    Provide a detailed description of your changes when submitting.

Troubleshooting

  1. Check Logs
    Use adb logcat to identify issues with the application.

  2. Review Issues
    Visit the Issues section for solutions or report a new problem.

  3. Documentation
    Refer to the /docs directory for additional guidance.

Licensing

The LogViewer application is licensed under the Katya Open Source License. You are free to use, modify, and distribute it under the terms of this license.

Thank you for using and contributing to Katya ® LogViewer! Let’s enhance the debugging experience together.

Clone this wiki locally