From Fedora Project Wiki
Note.png
please use this template to organize your proposal

Proposal: WAARTAA

An overview of the proposal

ABSTRACT

The main objective of my proposal is the buld a central hub for Waartaa which would enhance the storage and searching gear of the system. The idea is to integrate ElasticSearch with Waartaa that will support both storage and searching of irc user logs.The fulltext feature of Elasticsearch is to be applied and will thereby support both storage into the mongoDb and for future indexing and searching

INTRODUCTION

The present version of the IRC client Waartaa does not allow for users to download chat logs in various formats. It would always be great if the users would have the opportunity to directly download the log files in both text and html format from the IRC client itself. This would save time and add an extra feature that perhaps is not available with many IRC clients being used today. The present project aims to address this problem and work at a solution trying to provide Waartaa with the feature of downloading logs in text and html formats.

The need you believe it fulfills

The main need of existence of such a feature is to allow users to refer to past logs which may contain useful information, be it a meeting, a tutorial or a solution to a bug faced again and again.So without going for the extraneous process of self storing and retrieving the IRC logs ,Waartaa will be doing that for the users and that they can refer to the logs anytime in need.

Any relevant experience you have

  • Working with Django for the development of the college website of NetajiSubhash engineering College.https://github.com/debjeet-sarkar/dooby
  • Developed the Android app for Jadvapur University's fest.https://github.com/debjeet-sarkar/Sanskriti2014
  • Conducted workshop on python and php in Netaji Subhash engineering College under the banner of Spoken Tutorials ,IIT-B
  • Monitered and organized the online SWAT(Self workshop assessment test) in Netaji Subhash Engineering College under the banner of Spoken Tutorials.
  • Organized Python Workshop in Netaji Subhash Engineering College for Pycon Month initiative of Pycon India 2013.
  • How you intend to implement your proposal

    Create a module responsible for storing the IRC logs into the mongoDB db. Create a module that will be responsible for searching the IRC logs from the mongoDB db Create a module which will be responsible for the future retrieval of the logs when required.

    • The module responsible for storing the IRC logs will be made using logstash , a member of the elasticsearch family. Ref : http://logstash.net/
    • The module responsible for searching the IRC logs will be made using elasticsearch, using the full text search feature of it. Ref : http://www.elasticsearch.org/
    • The module responsible for viewing the IRC logs will be made using kibana, a member of the elasticsearch family. Ref : http://www.elasticsearch.org/overview/kibana/
    • A rough timeline for your progress

      Till 20 April

      • Study integration of elasticsearch with meteorJS and mongoDB

      21 April – 30 April

      • Gathering the required information for integrating logstash with Waartaa
      • Discussion with mentors regarding implementation of the same
      • Start off with the integration of elasticsearch with Waartaa

      1 May – 10 May

      • Gathering the required information for integrating elasticsearch with waartaa.
      • Discussion with mentors regarding implementation of the same
      • Start off with the implementation of kibana.

      11 May – 18 May

      • Discussion with mentors regarding the combined response of logstash and elasticsearch.
      • Discussion with mentors regarding implementation of the kibana

      19 May – 15 June

      • Integrate elasticsearch and logstash with waartaa.
      • Retrieving the data from the mongoDB backend to logstash.
      • Implementing the search algorithm on logstash, elasticsearch, i.e
      • Ref :http://logstash.net/docs/1.4.0/inputs/irc &
       http://logstash.net/docs/1.4.0/output/mongodb

      16 June – 22 June

      • Testing and deploying after the complete integration of the two tools.

      23 June :- MID-TERM EVALUATION
      24 June – 20 July

      • Integration of kibana with Waartaa

      21 July – 31 July

      • testing and deploying after the integration of the full text support system.

      1 August – 21 August

      • Documentation

      Have you communicated with a potential mentor? If so, who?

      Yes, I have communicated with Sayan Chowdhury and Ratnadeep Debnath