microsoft / correlationvector-cpp Goto Github PK

CorrelationVector-Cpp provides a reference C++ implementation of the CorrelationVector protocol for tracing and correlation of events through a distributed system.

License: MIT License

CMake 24.43% C++ 75.57%

correlationvector-cpp's Introduction

Correlation Vector-Cpp

CorrelationVector-Cpp provides the C++ implementation of the CorrelationVector protocol for tracing and correlation of events through a distributed system.

Correlation Vector

Background

Correlation Vector (a.k.a. cV) is a format and protocol standard for tracing and correlation of events through a distributed system based on a light weight vector clock. The standard is widely used internally at Microsoft for first party applications and services and supported across multiple logging libraries and platforms (Services, Clients - Native, Managed, Js, iOS, Android etc). The standard powers a variety of different data processing needs ranging from distributed tracing & debugging to system and business intelligence, in various business organizations.

For more on the correlation vector specification and the scenarios it supports, please refer to the specification repo.

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.

General feedback and discussions?

Please start a discussion on the Home repo issue tracker

correlationvector-cpp's People

Contributors

Stargazers

Watchers

Forkers

ezhangle kevinmiles bhaskers-blu-org2 taffywrinkle claudiusgonzo test-mass-forker-org-1

correlationvector-cpp's Issues

Fix missing or wrong Clang/AppleClang/MSVC Compiler argument

For MSVC

It appears that CMAKE_CXX_FLAGS_DEBUG and CMAKE_CXX_FLAGS_RELEASE have received wrong parameters value as MSVC compiler option in wrong way

For Clang/AppleClang

it appears that on MacOS clang compiler is : AppleClang , and this one isn't checked.
Also, compiler option : -Wno-unused-command-line-argument is missing that cause linker error

Make a new release

Would it be possible to make a new release with the changes that were added after 1.0?
The library can't be consumed without those changes, and I'm interested in making a vcpkg port.

Port to Vcpkg causes issue for package name and <PackageName>-config.cmake

As it appears that VCPKG doesn't support '' in a package name, possible names are something without '' (like correlation-vector or CorrelationVector)

the using of find_package(...) is impossible as the generated -config.cmake is : correlation_vector-config.cmake (note the underscore)

possible fix : this one can be fix with a patch that use a standard name like : correlation-vector

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Allowing creation from GUID string value

it'll be good if we can create cV object from a string guid

static guid create(const std::string&);

Binary encoding of MS GUID and standard UUID are different

The CV library uses libuuid/boost on non-Windows platforms and MS GUID on Windows. That difference causes an issue since the binary encoding of MS GUID and standard UUID are different (see: https://stackoverflow.com/questions/246930/is-there-any-difference-between-a-guid-and-a-uuid ).

Please add this C++ package to Nuget

Nuget currently has the C# implementation of the CorrelationVector, but no C++ package

Is this a x-plat consumable solution?

My team needs a x-plat implementation of correlation vector in C or C++.
Squinting at the CMake files, it doesn't seem like this code is meant to be consumed out-of-the-box.
Is this something we would be inetersted in making consumable via source and/or vcpkg for x-plat consumers?
Is there any roadmap for this planned?

CorrelationVector library doesn't implement some static functions

implementation of these functions are missing :

    static guid create(const guid_t&);
    static guid create(const std::array<unsigned char, 16>& bytes);
    static guid create(std::array<unsigned char, 16>&& bytes);