Litelog

I. Architecture

This project is built using cmake. For ease of use, build.sh is written to quickly call cmake .. and make commands. The file structure of the project is as follows:

.
├── build.sh                # compile bash script.
├── .clang-format           # clang-format config.
├── CMakeLists.txt          # project cmake file.
├── docs
├── .github                 # github workflow.
├── .gitignore
├── LICENSE
├── others                  # usage and some scripts.
│   ├── ini                     # ini file pattern.
│   ├── py                      # python scripts, used to extract log file from target machine.
│   └── version                 # version control information.
├── README.md
├── src                     # resource.
│   ├── buffer                  # log buffer.
│   ├── CMakeLists.txt          # cmake for litelog itself.
│   ├── controller              # a controller which could set litelog's action via socket.
│   ├── formatter               # write log from buffer into file.
│   ├── logger                  # move log from sink into buffer.
│   ├── main.cpp                # main function.
│   ├── sink                    # move log from kernel or socket into logger.
│   └── utils                   # some tools.
│       ├── config                  # init function, and some enum.
│       ├── date                    # get system time.
│       ├── global                  # global variable.
│       ├── socket                  # socket interface.
│       └── threadpool              # threadpool for logger.
├── test                    # unit test.
└── usag                    # example for others program that wish to use litelog.

II. Build

See reference on Build.

III. Usage

See reference on Usage.

IV. VSC Plug

litelog-highlighter is a VS Code plug, which is used to highlight the log lines. You could just search and install it in VSC.