https://github.com/arsdever/qspdlog

A simple Qt based widget for visualizing spdlog output.
https://github.com/arsdever/qspdlog

cpp logging qt qt6 spdlog widget

Last synced: about 1 month ago
JSON representation

A simple Qt based widget for visualizing spdlog output.

• Host: GitHub
• URL: https://github.com/arsdever/qspdlog
• Owner: arsdever
• License: mit
• Created: 2022-12-15T22:55:35.000Z (almost 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-28T22:33:50.000Z (6 months ago)
• Last Synced: 2024-09-29T07:42:03.075Z (about 1 month ago)
• Topics: cpp, logging, qt, qt6, spdlog, widget
• Language: C++
• Homepage:
• Size: 525 KB
• Stars: 51
• Watchers: 2
• Forks: 10
• Open Issues: 3
• Metadata Files:
  • Readme: readme.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# QSpdLog

![QSpdLog](docs/images/demo_screenshot.png)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/arsdever/qspdlog/build_linux.yml?label=linux&logo=github)](https://github.com/arsdever/qspdlog/actions/workflows/main_ci.yml?query=branch%3Amain+)

[![Coverage](https://img.shields.io/codecov/c/gh/arsdever/qspdlog?flag=uitests&logo=codecov&token=7d1a74f3-709e-4b2b-9b6f-c2ed5c36d7a4)](https://app.codecov.io/gh/arsdever/qspdlog/commit/4cb624e6fe8d0abcf810ba3b2ea9db69755c9ffd/tree)

This repository contains the source code of a library, which provides a Qt widget for displaying log messages coming from the [spdlog](https://github.com/gabime/spdlog) library.

## Features

* Display log messages in a tree view

* Display an icon for each log level

* Separate message structure from message content

* Search in messages

  * via regular expressions

  * use match case option

  * reuse search history

* Auto scrolling feature with various options

  * disabled

  * scroll to the bottom when a new message is added

  * scroll to the bottom when a new message is added unless the user scrolled up

* **many more to come**

* **[request or suggest new ones](https://github.com/arsdever/qspdlog/issues/new/choose)**

## Usage

In its initial implementation only CMake tool is considered. To use the library in your project, you have:

1. Add the library as a submodule (or any kind of folder in your machine)

   ```bash

   git submodule add https://github.com/arsdever/qspdlog.git

   ```

2. Add the library to your CMake project

   ```cmake

   add_subdirectory(qspdlog)

   ```

3. Add the library to your target

   ```cmake

   target_link_libraries(${PROJECT_NAME} qspdlog::lib)

   ```

4. Include the interface header into the source file where you want to instantiate the widget

   ```cpp

   #include 

   ```

5. Instantiate the widget, register loggers and show the widget

   ```cpp

   QSpdLogWidget* widget = new QSpdLogWidget();

   auto sink = widget->sink();

   // register the sink to whatever logger you want

   widget->show();

   ```

A complete example can be found in the [sample](sample) folder.

> Note: In the sample it's considered that you already added the library as a submodule.

## License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## Acknowledgments

* [spdlog](https://github.com/gabime/spdlog) for the logging library

* [Qt](https://www.qt.io/) for the GUI framework

## Projects using QSpdLog

* [gamify](https://github.com/arsdever/gamify)