dd-trace-cpp

KO | EN

gitlite — search

#python #go #rust #docker #windows #awesome #cli #kubernetes #vue #pytorch #security #ios #openai #open-source

(★ 19)

Datadog APM client for C++

dd-trace-cpp Latest Version Download

Download Latest Version (.zip)

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Datadog C++ Tracer

This `dd-trace-cpp` repository contains the Datadog C++ Tracer, which is the [Datadog Application
Performance Monitoring (APM)](https://docs.datadoghq.com/tracing) C++ client library.

## Usage Example

```c++
#include <datadog/span_config.h>
#include <datadog/tracer.h>
#include <datadog/tracer_config.h>

#include <chrono>
#include <iostream>
#include <thread>

int main() {
    namespace dd = datadog::tracing;

dd::TracerConfig config;
    config.service = "my-service";

const auto validated_config = dd::finalize_config(config);
    if (!validated_config) {
        std::cerr << validated_config.error() << '\n';
        return 1;
    }

dd::Tracer tracer{*validated_config};
    dd::SpanConfig options;

options.name = "parent";
    dd::Span parent = tracer.create_span(options);

std::this_thread::sleep_for(std::chrono::seconds(1));

options.name = "child";
    dd::Span child = parent.create_child(options);
    child.set_tag("foo", "bar");

std::this_thread::sleep_for(std::chrono::seconds(2));
}
```

See the [examples](examples) for more extensive usage examples.

## Platform Support

The library has been tested and is compatible on the following CPU architecture, OS and compiler
combinations:

- x86_64 and arm64 Linux with GCC 11.4;
- x86_64 and arm64 Linux with Clang 14;
- x86_64 Windows with MSVC 2022;
- arm64 macOS with Apple Clang 15.

## Building and Installation

### Requirements

`dd-trace-cpp` requires a [supported](#platform-support) C++17 compiler.

A recent version of CMake is required (`3.28`), which might not be in your system's package manager.
[bin/install-cmake](bin/install-cmake) is an installer for a recent CMake, on Linux.

### Building

Build this library from source using [CMake](https://cmake.org).

```shell
git clone 'https://github.com/datadog/dd-trace-cpp'
cd dd-trace-cpp
cmake -B build .
cmake --build build -j
```

By default CMake will generate both static and shared libraries. To build only one of them use
either `BUILD_SHARED_LIBS` or `BUILD_STATIC_LIBS`. Example:

```shell
cmake -B build -DBUILD_SHARED_LIBS=1 .
```

### Installation

Installation places a shared library and public headers into the appropriate system directories
(`/usr/local/[…]`), or to a specified installation prefix. Example:

```shell
# Install dd-trace-cpp into `.install/` within the source repository.
cmake --install build --prefix=.install
```

### Optional: Linking to the shared library

In case you decided to build the shared library:

When building an executable that uses `dd-trace-cpp`, specify the path to the installed headers
using an appropriate `-I` option. If the library was installed into the default system directories,
then the `-I` option is not needed.

```shell
c++ -I/path/to/dd-trace-cpp/.install/include -c -o my_app.o my_app.cpp
```

When linking an executable that uses `dd-trace-cpp`, specify linkage to the
built library using the `-ldd-trace-cpp` option and an appropriate `-L` option.
If the library was installed into the default system directories, then the `-L`
options is not needed. The `-ldd-trace-cpp` option is always needed.

```shell
c++ -o my_app my_app.o -L/path/to/dd-trace-cpp/.install/lib -ldd-trace-cpp
```

## Contributing

See the [contributing guidelines](CONTRIBUTING.md) if you would like to contribute to the Datadog
C++ Tracer.

## Security

If you discover a security vulnerablity in the Datadog C++ Tracer, please refer to the [Security
Policy](SECURITY.md).

dd-trace-cpp

dd-trace-cpp Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

dd-trace-cpp

dd-trace-cpp Latest Version Download

Today's picks

Was this content helpful?

Recent Feedback

Download README