Skip to content

feat(heap-profiling): make heap crates publishable #2236

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

Open
maxywb wants to merge 3 commits into
base: main
Choose a base branch
from
+14 −5
Open

feat(heap-profiling): make heap crates publishable #2236

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
89aaee5
chore(heap-profiling): make heap crates publishable
maxywb Jul 14, 2026
44d1631
chore(heap-profiling): make gotter publishable too
scottgerring Jul 15, 2026
b12ba30
make sure license for vendored USDT bits is included in published crate
scottgerring Jul 15, 2026
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
3 changes: 1 addition & 2 deletions libdd-profiling-heap-allocator/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ repository = "https://github.com/DataDog/libdatadog/tree/main/libdd-profiling-he
edition.workspace = true
rust-version.workspace = true
license.workspace = true
publish = false

[lib]
bench = false
Expand All @@ -22,7 +21,7 @@ bench = false
live-heap = ["libdd-profiling-heap-sampler/live-heap"]

[dependencies]
libdd-profiling-heap-sampler = { path = "../libdd-profiling-heap-sampler" }
libdd-profiling-heap-sampler = { version = "0.1.0", path = "../libdd-profiling-heap-sampler" }

[dev-dependencies]
criterion = "0.5.1"
Expand Down
3 changes: 1 addition & 2 deletions libdd-profiling-heap-gotter/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ repository = "https://github.com/DataDog/libdatadog/tree/main/libdd-profiling-he
edition.workspace = true
rust-version.workspace = true
license.workspace = true
Comment thread
scottgerring marked this conversation as resolved.
publish = false

[lib]
crate-type = ["lib", "cdylib"]
Expand All @@ -26,7 +25,7 @@ test-support = []

[target.'cfg(target_os = "linux")'.dependencies]
libc = "0.2"
libdd-profiling-heap-sampler = { path = "../libdd-profiling-heap-sampler" }
libdd-profiling-heap-sampler = { version = "0.1.0", path = "../libdd-profiling-heap-sampler" }

[target.'cfg(target_os = "linux")'.dev-dependencies]
libc = "0.2"
Expand Down
1 change: 0 additions & 1 deletion libdd-profiling-heap-sampler/Cargo.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ repository = "https://github.com/DataDog/libdatadog/tree/main/libdd-profiling-he
edition.workspace = true
rust-version.workspace = true
license.workspace = true

@chatgpt-codex-connector chatgpt-codex-connector Bot Jul 15, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P2 Badge Include BSD license metadata before publishing sampler

Once publish = false is removed, this crate will upload vendor/usdt.h (it appears in cargo package --list), and libdd-profiling-heap-sampler/vendor/README.md documents that file as BSD-2-Clause. The packaged crate does not include the workspace-level NOTICE/LICENSE, while license.workspace still advertises only Apache-2.0, so publishing this artifact would misstate/omit the BSD notice for the bundled header. Please include the BSD license/notice in the crate or update the package license metadata before publishing.

Useful? React with 👍 / 👎.

@scottgerring scottgerring Jul 15, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

This is a fair observation, and is waiting for a change on the license tool we use so that it can actually be actioned. I have asked internally in #opensource to get some direction on this. In the meantime the vendored notice and license and included in the source tree. I will add it to the crate metadata in the meantime.

DataDog/rust-license-tool#270

@scottgerring scottgerring Jul 15, 2026

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Added NOTICE to this package following the pattern in the rest of the repo covering this. This should satisfy our licensing requirements.

publish = false

[lib]
crate-type = ["lib", "staticlib"]
Expand Down
12 changes: 12 additions & 0 deletions libdd-profiling-heap-sampler/NOTICE
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Datadog libdatadog
Copyright 2021-2022 Datadog, Inc.

This product includes software developed at Datadog (<https://www.datadoghq.com/>).

--

This product bundles a copy of the libbpf/usdt single-header USDT
library in `libdd-profiling-heap-sampler/vendor/usdt.h`. That file is licensed
under the BSD 2-Clause License, Copyright (c) 2024 Meta Platforms, Inc.
and affiliates. The SPDX identifier and copyright notice are retained
verbatim in the file header. Upstream: <https://github.com/libbpf/usdt>.
Loading