base on Datadog shared rust-based library. For now only used in other products (e.g. Ruby or PHP libraries). # `libdatadog` <table> <tr> <td width="70%"> `libdatadog` provides a shared library containing common code used in the implementation of Datadog's libraries, including [Continuous Profilers](https://docs.datadoghq.com/tracing/profiler/). **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. </td> <td width="30%" align="center"> <img src="docs/logo.png" alt="libdatadog logo" width="150"/> </td> </tr> </table> ## Development ### Contributing See [`CONTRIBUTING.md`](CONTRIBUTING.md). ### Building Build `libdatadog` as usual with `cargo build`. #### Builder crate You can generate a release using the builder crate. This will trigger all the necessary steps to create the libraries, binaries, headers and package config files needed to use a pre-built libdatadog binary in a (non-rust) project. The default build does not include any capability so you'll need to list all features you want to include. You can see a full, up-to-date list of features in the `builder/Cargo.toml` file. Here's one example of using the builder crate: ```bash mkdir output-folder cargo run --bin release --features profiling,telemetry,data-pipeline,symbolizer,crashtracker,library-config,log,ddsketch -- --out output-folder ``` #### Build dependencies - Rust 1.84.1 or newer with cargo. See the Cargo.toml for information about bumping this version. - `cbindgen` 0.29 - `cmake` and `protoc` ### Running tests This project uses [cargo-nextest][nt] to run tests. ```bash cargo nextest run ``` #### Installing cargo-nextest The simplest way to install [cargo-nextest][nt] is to use `cargo install` like this. ```bash cargo install --locked '[email protected]' ``` #### Dev Containers Dev Containers allow you to use a Docker container as a full-featured development environment with VS Code. ##### Prerequisites - Install the [Dev Containers Extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers) in VS Code. - Docker must be installed and running on your host machine. ##### Available Containers We provide two Dev Container configurations: - **Ubuntu**: Full-featured development environment with all dependencies installed - **Alpine**: Lightweight alternative with minimal dependencies ##### Steps 1. Open a local VS Code window on the cloned repository. 2. Open the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P` on macOS) and select **"Dev Containers: Reopen in Container"**. 3. Choose either **Ubuntu** or **Alpine** configuration when prompted. 4. VS Code will build and connect to the selected container environment. The container includes all necessary dependencies for building and testing `libdatadog`. #### Docker container A dockerfile is provided to run tests in a Ubuntu linux environment. This is particularly useful for running and debugging linux-only tests on macOS. To build the docker image, from the root directory of the libdatadog project run ```bash docker build -f local-linux.Dockerfile -t libdatadog-linux . ``` To start the docker container, you can run ```bash docker run -it --privileged -v "$(pwd)":/libdatadog -v cargo-cache:/home/user/.cargo libdatadog-linux ``` This will: 1. Start the container in privileged mode to allow the container to run docker-in-docker, which is necessary for some integration tests. 1. Mount the current directory (the root of the libdatadog workspace) into the container at `/libdatadog`. 1. Mount a named volume `cargo-cache` to cache the cargo dependencies at ~/.cargo. This is helpful to avoid re-downloading dependencies every time you start the container, but isn't absolutely necessary. The `$CARGO_TARGET_DIR` environment variable is set to `/libdatadog/docker-linux-target` in the container, so cargo will use the target directory in the mounted volume to avoid conflicts with the host's default target directory of `libdatadog/target`. #### 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: ```bash cargo nextest run -E '!test(tracing_integration_tests::)' ``` [nt]: https://nexte.st/ ", Assign "at most 3 tags" to the expected json: {"id":"11602","tags":[]} "only from the tags list I provide: [{"id":77,"name":"3d"},{"id":89,"name":"agent"},{"id":17,"name":"ai"},{"id":54,"name":"algorithm"},{"id":24,"name":"api"},{"id":44,"name":"authentication"},{"id":3,"name":"aws"},{"id":27,"name":"backend"},{"id":60,"name":"benchmark"},{"id":72,"name":"best-practices"},{"id":39,"name":"bitcoin"},{"id":37,"name":"blockchain"},{"id":1,"name":"blog"},{"id":45,"name":"bundler"},{"id":58,"name":"cache"},{"id":21,"name":"chat"},{"id":49,"name":"cicd"},{"id":4,"name":"cli"},{"id":64,"name":"cloud-native"},{"id":48,"name":"cms"},{"id":61,"name":"compiler"},{"id":68,"name":"containerization"},{"id":92,"name":"crm"},{"id":34,"name":"data"},{"id":47,"name":"database"},{"id":8,"name":"declarative-gui "},{"id":9,"name":"deploy-tool"},{"id":53,"name":"desktop-app"},{"id":6,"name":"dev-exp-lib"},{"id":59,"name":"dev-tool"},{"id":13,"name":"ecommerce"},{"id":26,"name":"editor"},{"id":66,"name":"emulator"},{"id":62,"name":"filesystem"},{"id":80,"name":"finance"},{"id":15,"name":"firmware"},{"id":73,"name":"for-fun"},{"id":2,"name":"framework"},{"id":11,"name":"frontend"},{"id":22,"name":"game"},{"id":81,"name":"game-engine "},{"id":23,"name":"graphql"},{"id":84,"name":"gui"},{"id":91,"name":"http"},{"id":5,"name":"http-client"},{"id":51,"name":"iac"},{"id":30,"name":"ide"},{"id":78,"name":"iot"},{"id":40,"name":"json"},{"id":83,"name":"julian"},{"id":38,"name":"k8s"},{"id":31,"name":"language"},{"id":10,"name":"learning-resource"},{"id":33,"name":"lib"},{"id":41,"name":"linter"},{"id":28,"name":"lms"},{"id":16,"name":"logging"},{"id":76,"name":"low-code"},{"id":90,"name":"message-queue"},{"id":42,"name":"mobile-app"},{"id":18,"name":"monitoring"},{"id":36,"name":"networking"},{"id":7,"name":"node-version"},{"id":55,"name":"nosql"},{"id":57,"name":"observability"},{"id":46,"name":"orm"},{"id":52,"name":"os"},{"id":14,"name":"parser"},{"id":74,"name":"react"},{"id":82,"name":"real-time"},{"id":56,"name":"robot"},{"id":65,"name":"runtime"},{"id":32,"name":"sdk"},{"id":71,"name":"search"},{"id":63,"name":"secrets"},{"id":25,"name":"security"},{"id":85,"name":"server"},{"id":86,"name":"serverless"},{"id":70,"name":"storage"},{"id":75,"name":"system-design"},{"id":79,"name":"terminal"},{"id":29,"name":"testing"},{"id":12,"name":"ui"},{"id":50,"name":"ux"},{"id":88,"name":"video"},{"id":20,"name":"web-app"},{"id":35,"name":"web-server"},{"id":43,"name":"webassembly"},{"id":69,"name":"workflow"},{"id":87,"name":"yaml"}]" returns me the "expected json"