Skip to content

Latest commit

 

History

History
70 lines (43 loc) · 4.61 KB

README.md

File metadata and controls

70 lines (43 loc) · 4.61 KB
Raw

Rejuvenate-Logging-Levels

Build Status Coverage Status GitHub license DOI Java profiler

Introduction

Icon Developers usually choose log levels to filter information they would like to print. However, developers may not well estimate the cost and benefit for each log level, and log levels may change overtime with requirements. Our tools consist of Eclipse plugins which help developers adjust and rejuvenate log levels by using Degree of Interests (DOI) model. DOI value is a kind of real number for a program element which shows how developers are interested in it. It is computed from the interaction events between developer and element, such as developer edits the element. Transformation decision is made by analyzing the DOI values of enclosing methods for logging invocations.

Screenshot

Screenshot

Usage

Our tool could be run in three different purposes. For each purpose, it could be run in two ways.

Purposes:

  • Running transformation.
    • The command: "rejuvenate a log level".
  • Running evaluator for log level rejuvenation.
    • The command: "evaluate log projects".
  • Running evaluator for extracting method changes from git history.
    • The command: "evaluate mylyngit projects".

Two ways:

  • Select projects -> Right click -> Choose "Refactor" -> Choose the command by different purpose you run the tool.

  • Quick Assess -> Choose command.

Notice: Make sure there must be an active Mylyn task before running tool. Do not use a real Mylyn task as the plug-in just uses this task for bookkeeping purposes. Please make a separate (fake) task for this purpose. We will integrate this process in the future.

Settings

We have nine option settings:

  • Treat CONFIG/WARNING/SEVERE log levels as category and not traditional levels.
  • Treat CONFIG log level as a category and not a traditional level.
  • Never lower the logging level of logging statements within catch blocks.
  • Never lower the logging level of logging statements within immediate if statements.
  • Never lower logs with particular keywords in their log messages.
  • Never raise logs without particular keywords in their log messages.
  • Consistent log level transformations between overriding methods.
  • Do not change a log level in a logging statement if there exists an immediate if statement whose condition contains a log level.
  • Adjust transformations if their transformation distance is over maximum transformation distance.

Installation

Update Site

Our tool can be installed via Eclipse Update Site at https://raw.githubusercontent.com/ponder-lab/Logging-Level-Evolution-Plugin/master/edu.cuny.hunter.log.updatesite. Please install the latest version.

Development platform

It is developed on Eclipse for RCP and RAP, and its version is 2019-06. The download page: https://www.eclipse.org/downloads/packages/release/2019-06

Dependencies

The Common Refactoring Framework that the current tool uses requires Eclipse SDK, Eclipse SDK Tests, and Eclipse testing framework. Input "The Eclipse Project Updates" in the field of "Work with" after you clicked on the "Install New Software..." menu option under "Help" in Eclipse, then please check and install the three software mentioned above.

Limitations

Our tool may miss log levels when log levels are passed via parameters due to the current lack of data flow analysis issue 47.

Further information

Please see wiki.