https://github.com/lethalbit/sawmill

A structured logging and diagnostics library for C++
https://github.com/lethalbit/sawmill

diagnostics logging logging-facade logging-library tracing

Last synced: 10 days ago
JSON representation

A structured logging and diagnostics library for C++

• Host: GitHub
• URL: https://github.com/lethalbit/sawmill
• Owner: lethalbit
• License: bsd-3-clause
• Created: 2022-07-24T09:23:18.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2022-08-02T14:49:58.000Z (over 2 years ago)
• Last Synced: 2024-11-06T01:56:32.343Z (about 2 months ago)
• Topics: diagnostics, logging, logging-facade, logging-library, tracing
• Language: C++
• Homepage:
• Size: 5.64 MB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Sawmill

> **Warning** Lots of performance tuning has yet to be done!

> Due to the nature of the library, care will be taken to

> ensure that all of the hot path code will be as performant

> as possible. **This will take some time**.

Sawmill is a framework for instrumenting C++ applications to collect structured event-based diagnostic information, much in the same way that the [tokio](https://tokio.rs/) [tracing](https://tracing.rs/tracing/index.html) library does for rust.

## Documentation

Comprehensive documentation about sawmill and its usage can be found at [https://lethalbit.github.io/sawmill/](https://lethalbit.github.io/sawmill/).

## Configuring and Building

The following steps describe how to build Sawmill, it should be consistent for Linux, macOS, and Windows, but macOS and Windows remain untested.

### Prerequisites

To build Sawmill, ensure you have the following build time dependencies:

 * git

 * meson

 * ninja

 * g++ >= 11 or clang++ >= 11

Optionally, when also building with binding support (which is the default) you also need:

 * python >= 3.9

 * pybind11 >= 2.7.0

### Configuring

You can build sawmill with the default options, all of which can be found in [`meson_options.txt`](meson_options.txt). You can change these by specifying `-D=` at initial meson invocation time, or with `meson configure` in the build directory post initial configure.

To change the install prefix, which is `/usr/local` by default ensure to pass `--prefix ` when running meson for the first time.

In either case, simply running `meson build` from the root of the repository will be sufficient and place all of the build files in the `build` subdirectory.

### Building

Once you have configured sawmill appropriately, to simply build and install simply run the following:

```

$ ninja -C build

$ ninja -C build test # Optional: Run Tests

$ ninja -C build install

```

This will build and install Sawmill into the default prefix which is `/usr/local`, to change that see the configuration steps above.

### Notes to Package Maintainers

If you are building sawmill for inclusion in a distributions package system then ensure to set `DESTDIR` prior to running meson install.

There is also a `bugreport_url` configuration option that is set to this repositories issues tracker by default, it is recommended to change it to your distributions bug tracking page.

## License

Sawmill is licensed under the [BSD-3-Clause](https://spdx.org/licenses/BSD-3-Clause.html) license, the full text of which can be found in the [LICENSE](./LICENSE) file.