Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sjinks/opentelemetry-resource-detectors-cpp
Resource Detectors for OpenTelemetry (C++)
https://github.com/sjinks/opentelemetry-resource-detectors-cpp
opentelemetry opentelemetry-cpp opentelemetry-resource-detector resource-detector
Last synced: 27 days ago
JSON representation
Resource Detectors for OpenTelemetry (C++)
- Host: GitHub
- URL: https://github.com/sjinks/opentelemetry-resource-detectors-cpp
- Owner: sjinks
- License: mit
- Created: 2024-09-24T02:06:41.000Z (4 months ago)
- Default Branch: master
- Last Pushed: 2024-10-23T18:43:01.000Z (3 months ago)
- Last Synced: 2024-10-24T04:33:48.043Z (3 months ago)
- Topics: opentelemetry, opentelemetry-cpp, opentelemetry-resource-detector, resource-detector
- Language: C++
- Homepage:
- Size: 94.7 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# opentelemetry-resource-detectors-cpp
[](https://github.com/sjinks/opentelemetry-resource-detectors-cpp/actions/workflows/ci.yml)
[](https://github.com/sjinks/opentelemetry-resource-detectors-cpp/actions/workflows/codeql.yml)
[](https://sonarcloud.io/summary/new_code?id=sjinks_opentelemetry-resource-detectors-cpp)
Resource detectors for OpenTelemetry (C++).
The library provides the following resource detectors:
* [container](https://opentelemetry.io/docs/specs/semconv/resource/container/) (`container.id`);
* [process](https://opentelemetry.io/docs/specs/semconv/resource/process/) (`process.command_line`/`process.command` and `process.command_args`, `process.group_leader.pid`, `process.interactive`, `process.owner`, `process.parent_pid`, `process.pid`, `process.real_user.id`, `process.real_user.name`, `process.saved_user.id`, `process.saved_user.name`, `process.session_leader.pid`, `process.user.id`, `process.user.name`);
* [OS](https://opentelemetry.io/docs/specs/semconv/resource/os/) (`os.type`, `os.version`) and [host](https://opentelemetry.io/docs/specs/semconv/resource/host/) (`host.arch`, `host.name`).
| Resource | Supported OSes |
|------------------------------|-------------------------|
| `container.id` | Linux |
| `process.command` | Linux, MacOS |
| `process.command_args` | Linux, MacOS |
| `process.command_line` | Windows |
| `process.group_leader.pid` | Linux, MacOS |
| `process.interactive` | Linux, MacOS, Windows |
| `process.owner` | Linux, MacOS, Windows |
| `process.parent_pid` | Linux, MacOS, Windows |
| `process.pid` | Linux, MacOS, Windows |
| `process.real_user.id` | Linux, MacOS |
| `process.real_user.name` | Linux, MacOS, Windows |
| `process.saved_user.id` | Linux |
| `process.saved_user.name` | Linux |
| `process.session_leader.pid` | Linux, MacOS |
| `process.user.id` | Linux, MacOS |
| `process.user.name` | Linux, MacOS |
| `os.type` | Linux, MacOS, Windows |
| `os.version` | Linux, MacOS, Windows |
| `host.arch` | Linux, MacOS, Windows |
| `host.name` | Linux, MacOS, Windows |
## Installation
```shell
cmake -B build
cmake --build build
cmake --install build
```
**Dependencies:** [opentelemetry-cpp](https://github.com/open-telemetry/opentelemetry-cpp)
**Development Dependencies:** [Google Test](https://github.com/google/googletest) (required to build and run tests), [JSON for Modern C++](https://github.com/nlohmann/json) (required to build examples)
### CMake Options
| Option Name | Description | Default Value |
|------------------------------|----------------------------------|---------------|
| `WITH_TESTING` | Whether to enable tests | `ON` |
| `WITH_EXAMPLES` | Whether to build examples | `ON` |
| `INSTALL_RESOURCE_DETECTORS` | Whether to install the library | `ON` |
## Usage
```cmake
find_package(opentelemetry_resource_detectors CONFIG REQUIRED)
target_link_libraries(
my_target
PRIVATE
opentelemetry_resource_detectors::opentelemetry_resource_detectors
)
```
```cpp
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
#include
int main()
{
std::vector> detectors;
detectors.emplace_back(std::make_unique());
detectors.emplace_back(std::make_unique());
detectors.emplace_back(std::make_unique());
auto resource = opentelemetry::sdk::resource::Resource::Create({});
for (const auto& detector : detectors) {
auto detected = detector->Detect();
resource = resource.Merge(detected);
}
// Now that the resource is ready, pass it to providers
auto exporter = opentelemetry::exporter::trace::OStreamSpanExporterFactory::Create();
auto processor = opentelemetry::sdk::trace::SimpleSpanProcessorFactory::Create(
std::move(exporter)
);
auto provider =
opentelemetry::sdk::trace::TracerProviderFactory::Create(
std::move(processor),
resource // <===
);
const opentelemetry::nostd::shared_ptr api_provider(
provider.release()
);
opentelemetry::trace::Provider::SetTracerProvider(api_provider);
// Your code goes here
}
```
**Note:** unlike the OpenTelemetry JS SDK, the C++ SDK merges resources differently. In the JS SDK, `Resource.Merge()` overwrites old attributes. In the C++ SDK, it preserves old attributes.