Skip to content

amank22/Logvue-Plugin-Template

Repository files navigation


Logo Logo

Template for LogVue plugins.

LogVue is a tool which helps in monitoring, analysing, exporting local analytics from Android device and to use SQL-Like query to filter logs on desktop!


release License License

Analytics Supported

  • Sample In-house analytics

Install

  • Copy packaged zip in logVue plugins directory.

How to create a new plugin?

Prerequisites

  • JDK 18 is required to build this plugin (See download links below)
  • Set JDK 18 for this project (Either by setting in gradle.properties or through gradle setting in intellij editors)

Steps

  • Use this repo as template
  • Checkout your repository
  • Change/Create plugin module in plugins directory (See sample)
  • Add logVue api & pf4j dependencies as in sample's build.gradle file
  • Create a file for plugin extending Plugin(wrapper) to listen to start/stop/delete events. See SamplePlugin.kt
  • Create a file for extension where actual parsing of logs can be done. It needs to annotated with @Extension and must extend LogEventParser
  • filters() should be used to define a list of tags which are supported by this plugin.
  • validate() and parse() are used to consume analytics logs.
  • Convert the logs in LogItem which takes eventName and other arguments in analytics.

Issues?

Raise an issue on LogVue repository for any issues or discussion.

JDK 18 Download links

About

Template for logvue Plugins

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages