Skip to content

Fix endpoint paths from /heap to /allocs in documentation #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jul 7, 2025
Merged

Fix endpoint paths from /heap to /allocs in documentation #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ async fn main() {
}

let app = axum::Router::new()
.route("/debug/pprof/heap", axum::routing::get(handle_get_heap));
.route("/debug/pprof/allocs", axum::routing::get(handle_get_heap));

// run our app with hyper, listening globally on port 3000
let listener = tokio::net::TcpListener::bind("0.0.0.0:3000").await.unwrap();
Expand Down Expand Up @@ -89,7 +89,7 @@ fn require_profiling_activated(prof_ctl: &jemalloc_pprof::JemallocProfCtl) -> Re
Then running the application, we can capture a profile and view it the pprof toolchain.

```shell
curl localhost:3000/debug/pprof/heap > heap.pb.gz
curl localhost:3000/debug/pprof/allocs > heap.pb.gz
pprof -http=:8080 heap.pb.gz
```

Expand Down Expand Up @@ -117,8 +117,8 @@ We can then adjust the example above to also emit a flamegraph SVG:
#[tokio::main]
async fn main() {
let app = axum::Router::new()
.route("/debug/pprof/heap", axum::routing::get(handle_get_heap))
.route("/debug/pprof/heap/flamegraph", axum::routing::get(handle_get_heap_flamegraph));
.route("/debug/pprof/allocs", axum::routing::get(handle_get_heap))
.route("/debug/pprof/allocs/flamegraph", axum::routing::get(handle_get_heap_flamegraph));
// ...
}

Expand Down
4 changes: 2 additions & 2 deletions example/src/main.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,12 +16,12 @@ async fn main() {
v.push(i);
}

let app = axum::Router::new().route("/debug/pprof/heap", axum::routing::get(handle_get_heap));
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Claude said it didn't want to update the function name handle_get_heap. Do we want to make that change? Let me know.

let app = axum::Router::new().route("/debug/pprof/allocs", axum::routing::get(handle_get_heap));

// Add a flamegraph SVG route if enabled via `cargo run -F flamegraph`.
#[cfg(feature = "flamegraph")]
let app = app.route(
"/debug/pprof/heap/flamegraph",
"/debug/pprof/allocs/flamegraph",
axum::routing::get(handle_get_heap_flamegraph),
);

Expand Down