Aspektipohjaisen lokitusjärjestelmän toteutus

Abstract

Insinöörityön tarkoituksena oli lisätä asiakkaan asiakkuudenhallintasovelluksiin lokitusta mahdollisimman pienellä työmäärällä, mutta kuitenkin niin kattavasti, että sitä voitaisiin hyödyntää testauksessa.

Asiakkaan sovellukset olivat vielä kehityksessä. Ne oli toteutettu Javalla käyttäen Spring-ohjelmistokehystä. Sovelluksissa oli hyvin vähän olemassa olevaa lokitusta eikä sekään ollut kovin hyödyllistä. Lokituksen haluttiin olevan mahdollisimman vähätöistä ja helposti muokattavissa, mutta sen piti kuitenkin kattaa sovelluksien sisäinen toiminta mahdollisimman kattavasti.

Työ koostui olemassa olevan lokituksen analyysista, ratkaisuvaihtoehtojen kartoittamisesta, ratkaisuvalinnasta, toteutuksesta ja dokumentaation sekä ohjeistuksen tuottamisesta. Toteutettavaksi ratkaisuksi valittiin lokituksen lisääminen AspectJ-ohjelmistokehystä käyttäen niin, että olemassa olevaan koodiin generoitaisiin lokituksen toteuttava koodi ohjelman käännösvaiheessa.

Työ saatettiin loppuun onnistuneesti ja otettiin heti käyttöön sovellusten kehitys- ja testityössä. Tämän jälkeen tehtiin jonkin verran jälkityötä käytössä ilmi käyneiden ongelmien korjaamiseksi ja toiminnallisuuden laajentamiseksi.

The goal of this thesis was to add logging into the client’s customer relationship management applications with as little work as possible, while still covering enough of the applications internal functionality to be useful.

The client’s applications were still undergoing significant development, they were implemented with Java using the Spring framework. The applications had barely any logging and what existed was not very useful. The logging needed to be easily changeable with the fewest required changes while still covering as much of the functionality as possible.

The work consisted of analyzing the existing logging, determining usable solution options, choosing one of the options, implementing it and finally producing documentation and guidelines for the system. The chosen solution was to add logging by using the AspectJ framework to add advices that interacted with the existing code to generate logging without requiring changes to the code itself.

This work was finished successfully and immediately taken into use in development and testing of the applications. Some further follow-up has been done to add functionality and fix problems that were found in usage.