profserve 0.1.0

HTTP-Enabled Profiling for Rust
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

# ProfServe - HTTP-Enabled Profiling for Rust

[![Documentation](https://docs.rs/profserve/badge.svg)](https://docs.rs/profserve)
[![Crates.io](https://img.shields.io/crates/v/profserve)](https://crates.io/crates/profserve)
[![License](https://img.shields.io/crates/l/profserve)](https://crates.io/crates/profserve)
[![Download](https://img.shields.io/crates/d/profserve)](https://crates.io/crates/profserve)

ProfServe is a Rust crate that provides HTTP endpoints for performance profiling, built on top of `pprof-rs`. It enables remote profiling capabilities for your Rust applications with flamegraph generation and pprof data export.

## Features

- 🚀 **HTTP API** for remote profiling
- 🔥 **Flamegraph generation** in SVG format
- 🔒 **Async-ready** for modern Rust applications

## Quick Start

### Installation

Add to your `Cargo.toml`:

```toml
[dependencies]
profserve = "0.1"
```

### Basic Usage

```rust
fn main() {
    std::thread::spawn(|| profserve::http::serve(8080).expect("Failed to start profserve"));
    // your code goes here
}
```

### Making Requests

Get a 10-second profile as flamegraph:

```bash
curl -s "http://localhost:8080/prof/cpu?seconds=10&frequency=100&output=flamegraph" > profile.svg
```

Get raw text pprof data:

```bash
curl -s "http://localhost:8080/prof/cpu?seconds=10&output=text" > profile.txt
```

## API Endpoints

| Endpoint         | Method | Parameters                       | Description |
|------------------|--------|----------------------------------|-------------|
| `/prof/cpu`      | GET | `seconds`, `output`, `frequency` | Capture profile |