Nightingale Posing Mischievously

    flipper-plugin-eventbus-logger

    1.0.1 • Public • Published

    GitHub forks GitHub stars GitHub issues GitHub license


    Logo

    EventBus Logger - Flipper plugin

    Visualize your events in Flipper to analyze and debug your application.
    Explore the docs »

    View Demo · Report Bug · Request Feature

    Table of Contents

    1. Introduction
    2. Getting Started
    3. Usage
    4. Roadmap
    5. Contributing
    6. License
    7. Contact
    8. Acknowledgements

    Introduction

    ![Product Name Screen Shot][product-screenshot]

    EventBus Logger flipper is an event inspector to visualize the GreenBot EventBus' event traffic from a mobile app. The mobile app plugin acts as an interceptor for the events, collects each event data and sends to the Flipper desktop plugin. Any additional data can be send but plugin supports timestamp, eventType, stacktrace and eventBody out of the box.

    This Plugin is especially helpful during the debugging phase to track-down the events and their removal along the course of app feature usage.

    Built With

    Getting Started

    In order to use the EventBus logger, follow these steps.

    Prerequisites

    You'll need to integrate the Flipper in your app. Follow the official instructions here.

    Installation

    Application setup

    1. Clone the repo
      git clone https://github.com/SaqibJDev/EventBusLogger-Flipper.git
    2. Copy the Android plugin in your app.
    3. Register the Plugin with flipper client at app startup. (Please see the sample app for a reference)
    4. Adapt your eventbus base class to add EventBusLoggerFlipperPlugin as an interceptor.
    5. Install the app on the device or an emulator

    Flipper setup

    1. Open Flipper App
    2. Open Plugin Manager from left top
    3. Select install plugins
    4. Search for eventbus
    5. Install eventbus-logger
    6. Reload Flipper

    Usage

    Once the setup is done and app is installed, FLipper will recognize your app supporting EventBusLogger. It will be shown in the list of active plugins with a bus icon. Select the plugin to visualize the event traffic. In order to see the details, simply click on any event row.

    The plugin supports the following details:

    1. Event Class name
    2. Event type (Post Event, Post Sticky, Remove Sticky)
    3. Timestamp
    4. Details
      1. Key Value map data (if sent via application plugin)
      2. Json Event Body (if class has data members)
      3. Stacktrace to trace down the event execution

    Roadmap

    See the open issues for a list of proposed features (and known issues).

    Contributing

    Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.

    1. Fork the Project
    2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
    3. Commit your Changes (git commit -m 'Add some AmazingFeature')
    4. Push to the Branch (git push origin feature/AmazingFeature)
    5. Open a Pull Request

    License

    Distributed under the MIT License. See LICENSE for more information.

    Contact

    Hafiz Saqib Javed - @Saqib_J - saqib.javed87@gmail.com

    Project Link: https://github.com/SaqibJDev/EventBusLogger-Flipper

    Install

    npm i flipper-plugin-eventbus-logger

    DownloadsWeekly Downloads

    21

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    855 kB

    Total Files

    13

    Last publish

    Collaborators

    • saqib.javed