Skip to content

igorcadelima/quam

Repository files navigation

Welcome to QuAM Framework!

QuAM aims to be as flexible as possible while helping you with easing the way you monitor quality attributes. The basic goal of QuAM is to monitor your software in real-time based on its architecture without cluttering your code. All of the data collected is stored in JSON files in order to facilitate integration with other tools.


How does it work?

QuAM is an aspect-oriented program developed with AspectJ. It provides the developer with some Java Annotations which may be used to tell which code elements should be monitored and specify logging criteria. For those who would like to perform custom monitoring, QuAM may be extended so that you can log whatever you like.


How to use

Type the following command in your terminal to create your JAR file:

gradle clean jar

Now you can find the JAR file file under build/libs/ and add it to your project.

Note:

  • Run your program as an AspectJ application so that the framework can work.
  • Compile your software with the -parameters compiler option so that you can get the parameter's names in the logs. If you're using Eclipse IDE, open Window -> Preferences -> Java -> Compiler and then make sure Store information about method parameters (usable via reflection) is checked.

Assuming that you have successfully added QuAM to your project, you can now annotate your code with @Loggable and @NotLoggable and start to monitor your code.

Creator

Igor C. A. de Lima:

License

QuAM Framework is distributed under the Apache License, version 2.0.

Releases

No releases published

Packages

No packages published