libdatadog

libdatadog provides a shared library containing common code used in the implementation of Datadog's libraries, including Continuous Profilers.

(In a past life, libdatadog was known as libddprof but it was renamed when we decided to increase its scope).

NOTE: If you're building a new Datadog library/profiler or want to contribute to Datadog's existing tools, you've come to the right place! Otherwise, this is possibly not the droid you were looking for.

Development

Contributing

See CONTRIBUTING.md.

Building

Build libdatadog as usual with cargo build.

Builder crate

To generate a release with the builder crate use cargo build -p builder this will trigger all the necessary steps to create the libraries, binaries, headers and package config files needed to use libdatadog in your project. The default build does not include any capability so in order to add them here is the list of allowed features:

• profiling: includes the profiling ffi calls and headers to the package.
• telemetry: adds the telemetry symbols and headers to the package.
• data-pipeline: includes the data pipeline ffi calls to the library and headers to the package.
• crashtracker: adds crashtracking capabilities to the package.
• symbolizer: adds symbolizer capabilities to the package.

In order to set an output directory there's the LIBDD_OUTPUT_FOLDER environment varibale. Here's an example to create a package with all the features and save the relese on /opt/release folder:

LIBDD_OUTPUT_FOLDER=/opt/release cargo build -p builder --features profiling,telemetry,data-pipeline,crashtracker,symbolizer

Build scripts

This is the non-prefered way of building a release, it's use is discouraged and it will be soon deprecated in favour of using the builder crate.

To package a release with the generated ffi header and CMake module, use the build-profiling-ffi.sh / build-telemetry-ffi.sh helper scripts. Here's an example of using on of these scripts, placing the output inside /opt/libdatadog:

bash build-profiling-ffi.sh /opt/libdatadog

Build Dependencies

• Rust 1.76.0 or newer with cargo
• cbindgen 0.26
• cmake and protoc

Running tests

This project uses cargo-nextest to run tests.

cargo nextest run

Installing cargo-nextest

The simplest way to install cargo-nextest is to use cargo install like this.

cargo install --locked '[email protected]'

Skipping tracing integration tests

Tracing integration tests require docker to be installed and running. If you don't have docker installed or you want to skip these tests, you can run:

cargo nextest run -E '!test(tracing_integration_tests::)'

Please note that the locked version is to make sure that it can be built using rust 1.76.0, and if you are using a newer rust version, then it's enough to limit the version to 0.9.*.