Lokitietojen kerääminen ja hyödyntäminen

Abstract

Insinöörityön tarkoituksena oli luoda työn tilanneen yrityksen mobiilisovellukselle virheraportointijärjestelmä. Sovelluksen testausvaiheen läpi voi päästä jokin virhe, jota ei ole pystytty havaitsemaan huolellisesta testauksesta huolimatta. Hyvän virheraportointijärjestelmän avulla virheenkorjausprosessi nopeutuu ja helpottuu. Projektin tavoitteena oli luoda Android-kirjasto, joka kerää lokitietoja käyttäjän liikkeistä sovelluksessa ja virheen sattuessa luo kattavan virheraportin.

Projektin aikana perehdyttiin erilaisiin virheraportointijärjestelmiin ja niiden vahvuuksiin ja heikkouksiin. Tavoitteena oli saada yleiskuva hyvän virheraportin ominaisuuksista. Tavoitteena oli löytää mahdollisimman hyvin yrityksen tarpeiden mukaisia ominaisuuksia.

Insinöörityössä luotiin Java-ohjelmointikielellä Android-pohjainen DevocaLogger-kirjasto käyttäen Android Studiota. Kirjastosta tehtiin mahdollisimman helppokäyttöinen, jotta sen voi ottaa nopeasti käyttöön useissa eri projekteissa. Työn aikana kirjastosta tehtiin myös Javadoc-dokumentaatio sekä ohjeet käyttöönottoa varten.

DevocaLogger-kirjaston tarkoituksena on kerätä kaikki tarpeellinen tieto ohjelmoijien virheenkorjausprosessin helpottamiseksi. DevocaLoggerin muodostama virheraportti koostuu kuvakaappauksesta virheen tapahtumahetkeltä, lokitiedoista, vapaasti täytettävästä lisätiedosta sekä pinojäljityksestä. Ohjelmoijan vastuulle jää, mitä lokitietoja halutaan kerätä ja mitä näyttää lisätieto-osiossa. Virheraportti voidaan luoda automaattisesti virheen sattuessa, mutta on myös mahdollista luoda raportti manuaalisesti. DevocaLogger-kirjaston muodostamat virheraportit nopeuttavat virheen korjausta.

DevocaLoggerin automaattisella virheraportoinnilla varmistetaan, että kaikista virheistä muodostetaan kattava virheraportti. DevocaLogger-kirjasto otettiin käyttöön yrityksen mobiilisovelluksessa, ja se on osana jokapäiväistä ohjelmistokehitysprosessia.

The aim of the thesis was to create a bug reporting system for the mobile application of the company that ordered the work. Despite careful testing during the testing phase of an ap-plication, an error might end up to the finished version. A good bug reporting system speeds up and simplifies the error fixing process. The goal of the project was to create an Android library that collects log information about user movements in the app and in the event of an error generating a comprehensive bug report.

During the project, various bug reporting systems and their strengths and weaknesses were examined. The goal was to get an overview of the features of a good bug report. The aim was to find the features that best suited company's needs.

As a result of this thesis, an Android-based DevocaLogger library was created with Java programming language using Android Studio. The library was made as easy to use as pos-sible, so it could be quickly implemented into different projects. During the work, Javadoc documentation and instructions for the implementation of the library were created.

The purpose of the DevocaLogger library is to gather all the necessary information to ease the debugging process for programmers. The bug report generated by DevocaLogger con-sists of a screenshot, log data, additional information, and stacktrace. It is the responsibility of the programmer to decide what log information to collect and what to display in the addi-tional information section. A bug report can be generated automatically in the event of an error, but it is also possible to create one manually. Bug reports generated by the Devo-caLogger speed up the bug fixing process.

DevocaLogger's automatic bug reporting ensures that bug reports are generated from all errors. The DevocaLogger library was implemented to the company’s mobile application and it is part of the day-to-day software development process.