Git Product home page Git Product logo

dd-opentracing-cpp's Introduction

Datadog OpenTracing C++ Client

CircleCI

Usage

Usage docs are on the main Datadog website:

For some quick-start examples, see the examples folder.

Contributing

Before considering contributions to the project, please take a moment to read our brief contribution guidelines.

Build and Test (Linux and macOS)

Dependencies

Building this project requires the following tools installed:

  • Build tools (e.g. build-essential, xcode)
  • cmake >= 3.1

Additional libraries are installed via a script.

Build Steps

  • Clone the repository
    git clone https://github.com/DataDog/dd-opentracing-cpp
  • Install additional library dependencies (requires sudo)
    cd dd-opentracing-cpp
    sudo scripts/install_dependencies.sh
  • Generate build files using cmake
    mkdir .build
    cd .build
    cmake ..
  • Run the build
    make
  • (Optional) Run the tests
    cmake -DBUILD_TESTING=ON ..
    make
    ctest --output-on-failure
  • (Optional) Install to /usr/local
    make install

If you want sanitizers to be enabled, then add either the -DSANITIZE_THREAD=ON -DSANITIZE_UNDEFINED=ON or -DSANITIZE_ADDRESS=ON flags to cmake, running the tests will now also check with the sanitizers.

Build (Windows)

NOTE: This is currently Early Access, and issues should be reported only via GitHub Issues. Installation steps are likely to change based on user feedback and becoming available via Vcpkg.

Dependencies

Building this project requires the following tools installed:

  • Visual Studio 2019 with "Desktop development for C++" installed
  • Vcpkg
  • Git

Build Steps

The commands below should be executed in an x64 Native Tools Command Prompt shell.

  • Clone the repository
    cd %HOMEPATH%
    git clone https://github.com/DataDog/dd-opentracing-cpp
  • Generate build files using cmake
    cd dd-opentracing-cpp
    mkdir .build
    cd .build
    cmake -DCMAKE_TOOLCHAIN_FILE=%HOMEPATH%\vcpkg\scripts\buildsystems\vcpkg.cmake ..
  • Run the build
    cmake --build . -- -p:Configuration=RelWithDebInfo

Integration tests

Integration tests require additional tools installed:

Installation details can be extracted from the Dockerfile for the container that is usually used when running integration tests.

Run this command to run the integration tests directly.

test/integration/run_integration_tests_local.sh

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.