Skip to content

Commit

Permalink
WIP
Browse files Browse the repository at this point in the history
  • Loading branch information
CorrieScheepers committed Nov 7, 2023
1 parent 46e53f8 commit 6fff577
Show file tree
Hide file tree
Showing 8 changed files with 431 additions and 127 deletions.
10 changes: 5 additions & 5 deletions Chapters/Chapter1.tex
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@ \subsubsection{Review of the state of art studies}
\clearpage

\section{Problem statement}\label{sec:ch1_problemStatement}
Software maintenance is a vital part of the entire life cycle of any software system. In \Cref{sec:ch1_maintenanceProblems}, multiple challenges can make it harder to improve maintenance efforts with limited available resources. It is beneficial to prioritise maintenance to ensure that limited resources are used efficiently. \par A possible solution to this problem is using event logs to determine system usage, as it is a proven method industry to track system usage. Software developers can access third-party software logging tools to get the event logs. Most of the tools focus more on system runtime utilisation than user activities. There exist logging tools that can track user-based movements depending on the framework the software system is developed in\par Although there are live tools that can track events generated by the user, it is not guaranteed that log quality will be acceptable. Some much-needed logging attributes that will aid log analysis may not be logged.\par Designing and implementing a logging mechanism might bridge the gap between software maintenance and log analysis to create a system usage report.\par Software developers still need to design the overall logging mechanism and decide where to place the logging points to capture the event logs in a software system. There are proven methods to create a suitable logging mechanism, but not all of them include the analysis of the records for user-based utilisation to improve software maintenance. The problem statement can be summarised as:
Software maintenance is a vital part of the entire life cycle of any software system. \Cref{sec:ch1_maintenanceProblems}discussed why limited available resources make it more challenging to improve maintenance efforts. It is beneficial to prioritise maintenance to ensure that limited resources are used efficiently. \par A possible solution to this problem is using event logs to determine system usage due to event logging being a proven method in industry to track system usage. Software developers can access third-party software logging tools to get the event logs. The majority of tools focus on system runtime utilisation rather than user activities. Logging tools that track user-based movements do exist, depending on the framework the software system is developed in. \par Although there are live tools that track events generated by the user, it is not guaranteed that log quality will be acceptable. Important logging attributes that will aid log analysis may not be logged. \par Designing and implementing a logging mechanism could bridge the gap between software maintenance and log analysis to create a system usage report. \par Software developers still need to design the overall logging mechanism and decide where to place the logging points to capture the event logs in a software system. There are proven methods to create a suitable logging mechanism, but many do not include the analysis of the records for user-based utilisation to improve software maintenance. The problem statement can be summarised as:

\begin{center}
\begin{tcolorbox}[colback=lightgray, colframe=black, sharp corners=all, arc=4pt]
Expand All @@ -592,7 +592,7 @@ \section{Objectives of the study}\label{sec:ch1_objectives}

\newcommand{\objBi}{Implement the method to create a user-based logging mechanism on a test system}
\newcommand{\objBiSubA}{Define the user activity types and create the needed log attributes for a user-based event log.}
\newcommand{\objBiSubB}{Implement the logging points at strategic locations to capture the log attributes to create events logs.}
\newcommand{\objBiSubB}{Implement the logging points at strategic locations to capture the relevant log attributes to create events logs.}
\newcommand{\objBiSubC}{Use or create a log analysis tool to evaluate the log quality of the captured logs.}
\newcommand{\objBiSubD}{Implement a software maintenance prioritisation method in the log analysis.}
\newcommand{\objBii}{Verify the results for the test system's software maintenance prioritisation.}
Expand Down Expand Up @@ -622,13 +622,13 @@ \subsection{Empirical objectives:}\label{sec:ch1_empiricalObjective}

\section{Overview of the dissertation}
\subsubsection{Chapter 1: Introduction}
This chapter contains the background of software maintenance, event logging, and system utilisation analysis. It defines the complexities and general issues of software maintenance for software developers. Efficient use of limited resources requires software developers to implement better software maintenance decisions. Event logging is a proven method to get system information that can be used to assist with prioritising software maintenance to implement it efficiently.
This chapter discusses the background of software maintenance, event logging, and system utilisation analysis. It defines the complexities and general issues of software maintenance for software developers. Efficient use of limited resources requires software developers to implement better software maintenance decisions. Event logging is a proven method to gather system information that can be used to assist with prioritising software maintenance to implement it efficiently.

\subsubsection{Chapter 2: Methodology}
This chapter contains the design of the generic method used to create a logging mechanism from a set of defined logging points and attributes. The software system for which the logging mechanism is made is a Web-based application. The second part of this chapter is the system utilisation analysis, using the captured logs to create an analysis report.
This chapter discusses the design of the generic method used to create a logging mechanism from a set of defined logging points and attributes. The software system for which the logging mechanism is created is a web-based application. The second part of this chapter is the system utilisation analysis, using the captured logs to create an analysis report.

\subsubsection{Chapter 3: Results}
This chapter contains the results of implementing a logging mechanism in a case study web-based application, as designed in Chapter 2. The results of the implemented logging mechanism are analysed as part of a system utilisation analysis, and recommendations are made on improving the maintenance of the case study web-based application. The results are discussed and validated to show how they address the problem statement and fulfil the study objectives.

\subsubsection{Chapter 4: Conclusion}
This chapter concludes by creating a logging mechanism for system utilisation analysis to improve software maintenance for a Web-based application. Limitations and recommendations are also made based on methodology and results.
This chapter concludes by creating a logging mechanism for system utilisation analysis to improve software maintenance for a web-based application. Limitations and recommendations are also identified based on the methodology and results.
Loading

0 comments on commit 6fff577

Please sign in to comment.