On specifics of adaptive logging method implementation

Abstract

Relevancy of this work is based on the fact that having an understanding of why given code behaves the way it does, both during normal execution and when encountering erroneous states, is an invaluable part of a good software design. As software systems become more complex, the demand for solutions, that can give deeper insight into code execution, remains high. The goal of this work is to formalize a software tool able to provide better observability of a program. Main methods used are: analysis of common approaches such as monitoring and logging, formalization of main components and modeling of an example implementation based on the Singleton software pattern. As a result, “severity only” based logging was analysed and core parts of “adaptive logging method” were described in a similar manner. There are two distinct features of this method: log tagging and subsequent introduction of a configuration schema that is capable of adapting to changing requirements during software program execution. Systems utilizing such approach gain the ability to extract more precise information about execution flow and also can focus on particular components that might behave incorrectly. As this switch is designed to happen without restarting the observed program, it should be possible to debug and investigate some issues without the need to try and reproduce from scratch the state of an environment where those have occurred. An example of formal description based on the Singleton software pattern is also presented, describing necessary methods and their signatures required to set up a basic variant of an adaptive logging method. This approach could be utilized by a variety of different applications and programming languages as it is developed in general terms and all required abstractions should be present in multiple environments.

Актуальність цієї роботи полягає в тому, що розуміння причин чому певний код виконується певним чином, як протягом нормального циклу виконання, так і у випадку помилок, є важливою частиною хорошого дизайну програмного забезпечення. Оскільки комп’ютерні системи стають складнішими, запит на рішення, що дозволяють глибше поглянути в процес виконання коду, лишається на високому рівні. Метою даної роботи є формалізація програмного інструменту, здатного забезпечити кращу спостережність програми. Основними методами роботи є: аналіз поширених підходів, таких як моніторинг та логування, формалізація основних компонентів та моделювання прикладу реалізації на основі патерну програмування Singleton. В результаті було проаналізовано логгінг на основі «тільки критичність» і аналогічним чином описано основні частини «методу адаптивного логування». Є дві відмінні риси цього методу: тегування лог повідомлень і подальше введення схеми конфігурації, яка здатна адаптуватися до мінливих вимог під час виконання програми. Системи, що використовують такий підхід, мають можливість отримувати більш точну інформацію про хід виконання, а також можуть зосередитися на певних компонентах, які можуть поводитися некоректно. Оскільки таке перемикання відбувається без перезапуска програми, за якою спостерігають, має бути можливість налагоджувати та досліджувати деякі проблеми без необхідності намагатися відтворити з нуля стан середовища, в якому вони виникли. Також представлено приклад формального опису на основі патерну програмування Singleton, який описує методи та їхні сигнатури, необхідні для створення базового варіанту адаптивного методу логування. Цей підхід може бути використаний різними програмами та мовами програмування, оскільки він розроблений в загальних рисах і всі необхідні абстракції повинні бути присутніми в різних середовищах.