Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ess-dmsc/graylog-logger

A simple C++ library for writing log messages to console, file and Graylog server
https://github.com/ess-dmsc/graylog-logger

asio boost cmake conan graylog-logger graylog-server jenkins

Last synced: about 1 month ago
JSON representation

A simple C++ library for writing log messages to console, file and Graylog server

Awesome Lists containing this project

README 

        
[![DOI](https://zenodo.org/badge/80732581.svg)](https://zenodo.org/badge/latestdoi/80732581)



# Graylog logger



This is a simple logging library which can be used to send log messages to a Graylog server. This is done by creating messages in the [GELF](http://docs.graylog.org/en/2.1/pages/gelf.html) format and sending them to a Graylog server via TCP. For testing purposes a [Vagrant](https://www.vagrantup.com/) machine running Graylog can be used. A simple Vagrantfile for creating this set-up can be [found here](https://github.com/ess-dmsc/graylog-machine). The argument for creating yet another logging library instead of writing a plugin/sink/handler for an already existing one is that a relatively light weight solution was desired. The library has functionality for writing log messages to console and file as well. By default the library will only write log messages to console.



The repository is split into four parts:



* The logging library.

* Unit tests of the logging library which are completely self contained (i.e. does not require a Graylog server).

* A simple console application which uses the logging library.

* Some benchmarking code which is used for profiling and optimising the code as well as test for performance regression.



A sister project to this library is the Python logging handler [GraylogHandler](https://github.com/ess-dmsc/graylog-handler).



- Further documentation can be [found here.](documentation/README.md)



## Getting Started



These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.



### Prerequisites



The logging library has the following (requried) external dependencies:



* [moodycamel::ConcurrentQueue](https://github.com/cameron314/concurrentqueue) For message passing to and within the logging library.

* [JSONForModernCPP](https://github.com/nlohmann/json) For generating graylog GELF messages.

* [ASIO](http://think-async.com) For networking.



This library can also make use of the following (optional) dependencies:



* [libfmt](https://github.com/fmtlib/fmt) For doing fast (multi-threaded) string formatting.

* [GTest](https://github.com/google/googletest) For unit testing.

* [google-benchmark](https://github.com/google/benchmark) For benchmarking.



You will also need CMake (version ≥ 3.9) to build the project. The project makes use of library and language features provided by C++14. It might be possible to link to the library using compilers that only supports C++11 though this has not been tested.



Due to the use of ASIO, the library should compile on most \*nix systems and Windows 10 with no issues though only limited testing has been done.



### Installing

There are two methods for building this library. They are described below.



#### Using conan

When using conan to provide the dependencies, all the optional and required dependencies are provided automatically. To checkout and build the library, run the following commands:



```

git clone https://github.com/ess-dmsc/graylog-logger.git

cd graylog-logger

mkdir build

cd build

conan install .. --build=outdated

cmake ..

make install

```



#### Making a conan package

If you are creating a conan package of this library you should disable CMake from running Conan by providing the following argument to CMake: `-DCONAN=DISABLE`. Furthermore, you must also use the `cmake_find_package` generator for CMake to be able to find the dependencies.



#### System installed dependencies

If using conan is not an option, it is possible to build the library using system installed dependencies. This requires a bit more work though and might not be as reliable.



Run the following commands:



```

git clone https://github.com/ess-dmsc/graylog-logger.git

cd graylog-logger

mkdir build

cd build

cmake .. -DCONAN=DISABLE -DCMAKE_PREFIX_PATH=/path/to/dir/containing/the/concurrentqueue/directory/

make install

```



#### Documentation

The code has some documentation. To generate it, run _doxygen_ in the root of the repository i.e.:



```

cd graylog-logger

doxygen

```



## Running the tests

If compiled, the unit tests are run by running the ```unit_tests``` application in the ```unit_tests``` directory of the ```build```directory.



## Deployment



Examples illustrating how the library can be used can be found in the [examples.md](documentation/examples.md) file.



## Built With

* [CMAKE](https://cmake.org/) - Cross platform makefile generation

* [Conan](https://conan.io/) - Package manager for C++



## Contributing



Get in contact by [creating an issue](https://github.com/ess-dmsc/graylog-logger/issues). I will be happy to assist you making the changes that you want.



## Versioning



We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [releases on github](https://github.com/ess-dmsc/graylog-logger/releases).



[See description of changes](documentation/changes.md)



## Authors



* **Jonas Nilsson** - *Initial work* - [SkyToGround](https://github.com/SkyToGround)

* **Afonso Mukai** - Provided much assistance in setting up the continous integration system.

* **Matthew Jones** - Improved the CMake code and suggested improvements to the interface. 



See also the list of [contributors](https://github.com/ess-dmsc/graylog-logger/graphs/contributors) to this project.



## License



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