Adding `groundwork` library as a dependency

Run this command in a terminal, in your project's directory:

cargo add groundwork

To add it manually, edit your project's Cargo.toml file and add to the [dependencies] section:

groundwork = "0.1.0"

The groundwork library will be automatically available globally. Read the groundwork library documentation.

Back to the crate overview.

Readme

Groundwork

Groundwork is a library that provides a status page for your Rust process.

The status page displays information about the process, including:

Memory usage
Allocator usage
CPU usage
File descriptors
Sockets
Logs / tracing output
API Calls information

Currently, only Poem is supported. However, adding support for Axum and other web frameworks should be straightforward. If your service doesn't integrate with any web frameworks, integrating Poem is relatively simple.

Note: Only Linux and macOS are supported at this time.

Getting Started

To begin, add next dependencies to your Cargo.toml file:

groundwork = "0.1"
alloc-metrics = "0.1"

And copy the necessary lines from the hello_world example.

Adding groundwork library as a dependency

Adding `groundwork` library as a dependency